conversation_list
data object
meta object
Conversations currently handled by an AI assistant
payload object[]
array of conversations
ID of the conversation
messages object[]
The ID of the message
The text content of the message
The ID of the account
The ID of the inbox
The ID of the conversation
The type of the message
Possible values: [0, 1, 2, 3]
The time at which message was created
The time at which message was updated
The flags which shows whether the message is private or not
The status of the message
Possible values: [sent, delivered, read, failed, null]
The source ID of the message
The type of the template message
Possible values: [text, input_text, input_textarea, input_email, input_select, cards, form, article, incoming_email, input_csat, integrations, sticker, voice_call, null]
The content attributes for each content_type
The type of the sender
Possible values: [Contact, User, AgentBot, Assistant, null]
The ID of the sender
The external source IDs of the message
The additional attributes of the message
The processed message content
The sentiment of the message
The conversation object
The file object attached to the image
User/Agent/AgentBot object
Account Id
UUID of the conversation
The object containing additional attributes related to the conversation
The last activity at of the agent
The last activity at of the assignee
Whether the conversation can be replied to
The last activity at of the contact
The object to save custom attributes for conversation, accepts custom attributes key and value
ID of the inbox
The labels of the conversation
Whether the conversation is muted
The time at which the conversation will be unmuted
The status of the conversation
Possible values: [open, resolved, pending]
The time at which conversation was created
The time at which conversation was updated
The time at which conversation was created
The time at which the first reply was created
The number of unread messages
last_non_activity_message object
The last non activity message
- message
- null
The ID of the message
The text content of the message
The ID of the account
The ID of the inbox
The ID of the conversation
The type of the message
Possible values: [0, 1, 2, 3]
The time at which message was created
The time at which message was updated
The flags which shows whether the message is private or not
The status of the message
Possible values: [sent, delivered, read, failed, null]
The source ID of the message
The type of the template message
Possible values: [text, input_text, input_textarea, input_email, input_select, cards, form, article, incoming_email, input_csat, integrations, sticker, voice_call, null]
The content attributes for each content_type
The type of the sender
Possible values: [Contact, User, AgentBot, Assistant, null]
The ID of the sender
The external source IDs of the message
The additional attributes of the message
The processed message content
The sentiment of the message
The conversation object
The file object attached to the image
User/Agent/AgentBot object
The last activity at of the conversation
The priority of the conversation
The time at which the conversation was waiting
The ID of the SLA policy
The applied SLA
meta object
sender object
The additional attributes of the sender
The availability status of the sender
The email of the sender
ID fo the sender
The name of the sender
The phone number of the sender
Whether the sender is blocked
The identifier of the sender
Avatar URL of the contact
The custom attributes of the sender
The last activity at of the sender
The created at of the sender
Channel Type
assignee object
Possible values: [agent, administrator]
Available for users who are created through platform APIs and has custom attributes associated.
accounts object[]
Possible values: [administrator, agent]
Whether the hmac is verified
{
"data": {
"meta": {
"mine_count": 0,
"unassigned_count": 0,
"assigned_count": 0,
"all_count": 0,
"ia_count": 0
},
"payload": [
{
"id": 0,
"messages": [
{
"id": 0,
"content": "string",
"account_id": 0,
"inbox_id": 0,
"conversation_id": 0,
"message_type": 0,
"created_at": 0,
"updated_at": 0,
"private": true,
"status": "sent",
"source_id": "string",
"content_type": "text",
"content_attributes": {},
"sender_type": "Contact",
"sender_id": 0,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "string",
"sentiment": "Unknown Type: object,null",
"conversation": "Unknown Type: object,null",
"attachment": "Unknown Type: object,null",
"sender": {}
}
],
"account_id": 0,
"uuid": "string",
"additional_attributes": {},
"agent_last_seen_at": 0,
"assignee_last_seen_at": 0,
"can_reply": true,
"contact_last_seen_at": 0,
"custom_attributes": {},
"inbox_id": 0,
"labels": [
"string"
],
"muted": true,
"snoozed_until": 0,
"status": "open",
"created_at": 0,
"updated_at": 0,
"timestamp": 0,
"first_reply_created_at": 0,
"unread_count": 0,
"last_non_activity_message": {
"id": 0,
"content": "string",
"account_id": 0,
"inbox_id": 0,
"conversation_id": 0,
"message_type": 0,
"created_at": 0,
"updated_at": 0,
"private": true,
"status": "sent",
"source_id": "string",
"content_type": "text",
"content_attributes": {},
"sender_type": "Contact",
"sender_id": 0,
"external_source_ids": {},
"additional_attributes": {},
"processed_message_content": "string",
"sentiment": "Unknown Type: object,null",
"conversation": "Unknown Type: object,null",
"attachment": "Unknown Type: object,null",
"sender": {}
},
"last_activity_at": 0,
"priority": "string",
"waiting_since": 0,
"sla_policy_id": 0,
"applied_sla": {},
"sla_events": [
{}
],
"meta": {
"sender": {
"additional_attributes": {},
"availability_status": "string",
"email": "string",
"id": 0,
"name": "string",
"phone_number": "string",
"blocked": true,
"identifier": "string",
"thumbnail": "string",
"custom_attributes": {},
"last_activity_at": 0,
"created_at": 0
},
"channel": "string",
"assignee": {
"id": 0,
"access_token": "string",
"account_id": 0,
"available_name": "string",
"avatar_url": "string",
"confirmed": true,
"display_name": "string",
"message_signature": "string",
"email": "string",
"hmac_identifier": "string",
"inviter_id": 0,
"name": "string",
"provider": "string",
"pubsub_token": "string",
"role": "agent",
"ui_settings": {},
"uid": "string",
"type": "string",
"custom_attributes": {},
"accounts": [
{
"id": 0,
"name": "string",
"status": "string",
"active_at": "2024-07-29T15:51:28.071Z",
"role": "administrator",
"permissions": [
"string"
],
"availability": "string",
"availability_status": "string",
"auto_offline": true,
"custom_role_id": 0,
"custom_role": "Unknown Type: object,null"
}
]
},
"hmac_verified": true
}
}
]
}
}