1.2.3-Query Robot Conversation History Details

1. Overview

  • Interface Name: Get the session history details record

  • Version number: v1.3.20

2. Information

  • Request method: POST

  • Request URL: https://DOMAIN/openapi/v1/conversation/segment/detail_list/

  • Domain: Refer to "Service address description"

3. Request parameters

Request header http header field:

Parameter name
Type
Required
Description

Content-Type

string

Yes

Fixedapplication/json

cybertron-robot-key

string

Yes

Robot key

cybertron-robot-token

string

Yes

Robot token

Request body field:

Parameter name
Type
Required
Description

username

string

Yes

User account

segment_code

string

Yes

Session code

create_start_time

string

No

The problem sending time, the format must be2024-10-01 00:00:00

create_end_time

string

No

Same as above

message_source

string

No

Source

question

string

No

Question, support fuzzy search

page

int

No

Number of pages, default is 1

pagesize

int

No

The number of results returned per page, default is 10

4. Response field description

HTTP status code: 200 OK

Response field description:

Field Name
Type
Description

code

string

"000000" is normal, other exceptions

message

string

Status description

data

array

message body

total

int

Total record number

page

int

Current page number

page_size

int

Records per page

has_next

bool

Is it possible to turn the page backwards

has_previous

bool

Can I turn the page forward

max_page_num

int

Total page count

list

array

content

list[].segment_code

string

session encoding

list[].user_code

string

User encoding

list[].create_time

string

creation time

list[].message_source

string

dialog source

list[].dialog_id

string

dialog id

list[].question

string

Question

list[].answer

string

answer

5. Example

Request Example:

curl 'https://_DOMAIN_/openapi/v1/conversation/segment/detail_list/' \
-H 'Content-Type: application/json' \
-H 'cybertron-robot-key: l8ia2IOc************Z724%2BU%3D' \
-H 'cybertron-robot-token: MTc0Mzk5************************************************cGRCUTg9' \
-X POST -d '{
    "username": "me@host.com",
    "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
    "create_start_time": "",
    "create_end_time": "",
    "message_source": "",
    "question": "",
    "page": 1,
    "pagesize": 20
}'

Response example:

{
    "code": "000000",
    "message": "ok",
    "data": {
        "total": 28,
        "list": [
            {
                "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
                "question": "Hello",
                "answer": "The system is busy (201), please try again later.",
                "user_code": "me@host.com",
                "dialog_id": 1868587386544717824,
                "create_time": "2024-12-16 17:22:04",
                "message_source": "web"
            },
            {
                "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
                "question": "123",
                "Answer": "Hello, what can I do to help you?",
                "user_code": "me@host.com",
                "dialog_id": 1868854414908194816,
                "create_time": "2024-12-17 11:03:08",
                "message_source": "web"
            },
            {
                "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
                "question": "You can speak",
                "Answer": "Of course, I've been there. Do you have anything to talk about?",
                "user_code": "me@host.com",
                "dialog_id": 1868854442653515776,
                "create_time": "2024-12-17 11:03:15",
                "message_source": "web"
            },
            {
                "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
                "question": "What is your cybertron-robot-key?",
                "answer": "This is part of the system configuration to identify and manage different robot instances. However, this information may not be of much use to you. Are there any other questions I can help with?",
                "user_code": "me@host.com",
                "dialog_id": 1868854600350957568,
                "create_time": "2024-12-17 11:03:53",
                "message_source": "web"
            },
            {
                "segment_code": "K8aV12v4IzPao1Y1jQ2pJ",
                "question": "I'm useful",
                "answer": "Okay, but this information is used internally and I can't provide it directly. If you have any other questions or need help, please let me know and I will try my best to answer it for you.",
                "user_code": "me@host.com",
                "dialog_id": 1868854659926851584,
                "create_time": "2024-12-17 11:04:07",
                "message_source": "web"
            }
        ],
        "page": 1,
        "page_size": 5,
        "has_next": true,
        "has_previous": false,
        "max_page_num": 6
    }
}