conversation_messages
meta object
Labels associated with the conversation
additional_attributes object
Additional attributes of the conversation
browser object
Name of the device
Name of the browser
Name of the platform
Version of the browser
Version of the platform
Referrer URL
initiated_at object
Timestamp when the conversation was initiated
Browser language setting
Conversation language
contact object
additional_attributes object
The object containing additional attributes related to the contact
City of the contact
Country of the contact
Country code of the contact
IP address when the contact was created
The custom attributes of the contact
The email address of the contact
The ID of the contact
The identifier of the contact
The name of the contact
The phone number of the contact
The thumbnail of the contact
Whether the contact is blocked
The type of entity
Possible values: [contact]
assignee objectnullable
The agent assigned to the conversation
The effective availability status of the agent, derived from the configured availability, auto-offline setting, and current presence. To update an agent's configured availability, use the availability field in create or update requests.
Possible values: [online, busy, offline]
Whether the agent is automatically marked offline when they are away.
Whether the agent has confirmed their email address.
The email of the agent
The available name of the agent
The name of the agent
The role of the agent
Possible values: [agent, administrator]
The thumbnail of the agent
The custom role id of the agent
Timestamp when the agent last saw the conversation
Timestamp when the assignee last saw the conversation
payload object[]
List of messages in the conversation
The ID of the message
The text content of the message
The ID of the inbox
The ID of the conversation
The type of the message (0: incoming, 1: outgoing, 2: activity, 3: template)
Possible values: [0, 1, 2, 3]
The type of the message content
Possible values: [text, input_text, input_textarea, input_email, input_select, cards, form, article, incoming_email, input_csat, integrations, sticker, voice_call]
The status of the message
Possible values: [sent, delivered, read, failed]
content_attributes object
The content attributes for each content_type
ID of the message this is replying to
The echo ID of the message, used for deduplication
The timestamp when message was created
The flag which shows whether the message is private or not
The source ID of the message
sender object
additional_attributes object
The object containing additional attributes related to the contact
City of the contact
Country of the contact
Country code of the contact
IP address when the contact was created
The custom attributes of the contact
The email address of the contact
The ID of the contact
The identifier of the contact
The name of the contact
The phone number of the contact
The thumbnail of the contact
Whether the contact is blocked
The type of entity
Possible values: [contact]
attachments object[]
The list of attachments associated with the message
The ID of the attachment
The ID of the message
The type of the attached file
Possible values: [image, video, audio, file, location, fallback, share, story_mention, contact, ig_reel]
The ID of the account
The URL of the attached file
The thumbnail URL of the attached file
The size of the attached file in bytes
{
"meta": {
"labels": [
"string"
],
"additional_attributes": {
"browser": {
"device_name": "string",
"browser_name": "string",
"platform_name": "string",
"browser_version": "string",
"platform_version": "string"
},
"referer": "string",
"initiated_at": {
"timestamp": "string"
},
"browser_language": "string",
"conversation_language": "string"
},
"contact": {
"additional_attributes": {
"city": "string",
"country": "string",
"country_code": "string",
"created_at_ip": "string"
},
"custom_attributes": {},
"email": "string",
"id": 0,
"identifier": "string",
"name": "string",
"phone_number": "string",
"thumbnail": "string",
"blocked": true,
"type": "contact"
},
"assignee": {
"id": 0,
"account_id": 0,
"availability_status": "online",
"auto_offline": true,
"confirmed": true,
"email": "string",
"available_name": "string",
"name": "string",
"role": "agent",
"thumbnail": "string",
"custom_role_id": 0
},
"agent_last_seen_at": "string",
"assignee_last_seen_at": "string"
},
"payload": [
{
"id": 0,
"content": "string",
"inbox_id": 0,
"conversation_id": 0,
"message_type": 0,
"content_type": "text",
"status": "sent",
"content_attributes": {
"in_reply_to": "string"
},
"echo_id": "string",
"created_at": 0,
"private": true,
"source_id": "string",
"sender": {
"additional_attributes": {
"city": "string",
"country": "string",
"country_code": "string",
"created_at_ip": "string"
},
"custom_attributes": {},
"email": "string",
"id": 0,
"identifier": "string",
"name": "string",
"phone_number": "string",
"thumbnail": "string",
"blocked": true,
"type": "contact"
},
"attachments": [
{
"id": 0,
"message_id": 0,
"file_type": "image",
"account_id": 0,
"data_url": "string",
"thumb_url": "string",
"file_size": 0
}
]
}
]
}