List all chats
Query parameters
The chats will be sorted by start_timestamp, whether to return the chats in ascending or descending order.
Limit the number of chats returned. Default 50, Max 1000. To retrieve more than 1000, use pagination_key to continue fetching the next page.
The pagination key to continue fetching the next page of chats. Pagination key is represented by a chat id here, and it's exclusive (not included in the fetched chats). The last chat id from the list chats is usually used as pagination key here. If not set, will start from the beginning.
Response
Successfully retrieved all chats.
Example response
[
{
"chat_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
"version": 1,
"retell_llm_dynamic_variables": {
"customer_name": "John Doe"
},
"collected_dynamic_variables": {
"last_node_name": "Test node"
},
"chat_status": "ongoing",
"chat_type": "api_chat",
"start_timestamp": 1703302407333,
"end_timestamp": 1703302428855,
"transcript": "Agent: hi how are you doing?\nUser: Doing pretty well. How are you?\nAgent: That's great to hear! I'm doing well too, thanks! What's up?\nUser: I don't have anything in particular.\nAgent: Got it, just checking in!\nUser: Alright. See you.\nAgent: have a nice day\n",
"message_with_tool_calls": [
{
"message_id": "Jabr9TXYYJHfvl6Syypi88rdAHYHmcq6",
"role": "agent",
"content": "hi how are you doing?",
"created_timestamp": 1703302428855
}
],
"chat_cost": {
"product_costs": [
{
"product": "elevenlabs_tts",
"unit_price": 1,
"cost": 60
}
],
"combined_cost": 70
},
"chat_analysis": {
"chat_summary": "The agent messages user to ask question about his purchase inquiry. The agent asked several questions regarding his preference and asked if user would like to book an appointment. The user happily agreed and scheduled an appointment next Monday 10am.",
"user_sentiment": "Positive",
"chat_successful": true
}
}
]Changes
Changed in 5 of the 28 revisions of this API.2798
- ▲
the
//response's property type changed from no type tostringfor statusresponse-property-type-changed
- ▲
the
//response's property type changed from no type tostringfor statusresponse-property-type-changed
- ▲
- ○
endpoint deprecated
endpoint-deprecated
- ○
- ▲
the
//////response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ▲
the
//////response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ▲
the
//////response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ▲
the
//////response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ▲
the
//////response's property type changed fromobjectto no type for statusresponse-property-type-changed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ▲
removed the required property
///////from the response with the statusresponse-required-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///////from the response with the statusresponse-optional-property-removed
- ○
added
subschema #2to the//////response propertyallOflist for the response statusresponse-property-all-of-added
- ○
added
subschema #2to the//////response propertyallOflist for the response statusresponse-property-all-of-added
- ○
added
subschema #2to the//////response propertyallOflist for the response statusresponse-property-all-of-added
- ○
added
subschema #2to the//////response propertyallOflist for the response statusresponse-property-all-of-added
- ○
added
subschema #2to the//////response propertyallOflist for the response statusresponse-property-all-of-added
- ▲
- ○
added the optional property
///////to the response with the statusresponse-optional-property-added
- ○
- ○
added the optional property
////to the response with the statusresponse-optional-property-added
- ○