API Description
Query the conversation list for a specified agent.
Basic Information
| Request Method | Request URL |
| GET | https://api.helpbots.ai/api/chats/conversation-list |
Request Parameters
Header
| Parameter Name |
Value
|
Description |
|---|---|---|
| x-api-key | $apikey |
Access token used to verify client identity. You can generate the token in the dashboard. For details, see Get API Key |
Query Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| id | int | Yes |
Agent ID of the conversation to query |
| conversation_type | string | No |
Conversation type to query Types: DEBUG, API, SDK Omit to return all types |
| page | int | No |
Page number for pagination Default: 1 |
| pagesize | int | No |
Page size Default: 20 |
Examples
Request Example
curl --location --request GET 'https://api.helpbots.ai/api/chats/conversation-list?id=18&page=1&pagesize=20' \
--header 'x-api-key: yourapikey' \Response Example
{
"data": {
"list": [
{
"conversation_id": "do19exkxdk0zd5tr********", # Conversation ID
"conversation_type":"API", # Conversation type
"add_time": "1745741991" # Conversation creation time
},
{
"conversation_id": "yy8rrpbivj7ld2a6********",
"conversation_type":"DEBUG",
"add_time": "1745571788"
}
],
"total": 2,
"page": 1,
"page_size": 20
},
"msg": "Success",
"code": 200
}