public_conversation
Id of the conversation
UUID of the conversation
The inbox id of the conversation
Timestamp of when the contact last seen the conversation (Unix timestamp)
The status of the conversation
Possible values: [open, resolved, pending, snoozed]
Timestamp of when the agent last seen the conversation (Unix timestamp)
messages object[]
Messages in the conversation
Id of the message
Text content of the message. Can be null for attachment-only messages.
Denotes the message type. Possible values: 0 (incoming), 1 (outgoing), 2 (activity), 3 (template)
Content type of the message
Additional content attributes of the message
Created at Unix timestamp of the message
Display Id of the conversation the message belongs to
attachments object[]
Attachments if any
Id of the attachment
Id of the parent message
Type of the attached file
Possible values: [image, audio, video, file, location, fallback, share, story_mention, contact, ig_reel, ig_post, ig_story, embed]
Id of the account
File extension
URL of the file. Can be null when an attachment variant has no external URL.
URL of the file thumbnail
File size in bytes
Width of the attachment when available
Height of the attachment when available
Latitude for location attachments
Longitude for location attachments
Fallback title for location, fallback, and contact attachments when available
Metadata for contact attachments
Transcribed text for audio attachments
Attachment payload. Available fields vary by attachment file_type.
sender object
Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.
Id of the sender
Name of the sender when available
Avatar URL of the sender. Present for senders of type user, agent_bot, and assistant. Not present for contact senders (use thumbnail instead).
Avatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it.
Type of the sender
Possible values: [contact, user, agent_bot, assistant]
Display name for user senders
Availability status for user senders
Email of the sender when the sender is a contact
Phone number of the sender when the sender is a contact
Identifier of the sender when the sender is a contact
Whether the sender is blocked when the sender is a contact
Additional attributes when the sender is a contact and available
Custom attributes when the sender is a contact and available
Description when the sender is a assistant assistant
Created timestamp in ISO 8601 format when the sender is a assistant assistant
Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.
contact object
Full serialized contact record returned when the public API renders a Contact model directly.
Id of the contact
Name of the contact when available
Email of the contact
Phone number of the contact
Identifier of the contact
Whether the contact is blocked
Additional attributes of the contact when present
Custom attributes of the contact when present
Contact type of the contact when available
Country code of the contact
Last activity timestamp of the contact in ISO 8601 format
Created timestamp of the contact in ISO 8601 format
Updated timestamp of the contact in ISO 8601 format
Last name of the contact
Middle name of the contact
Location of the contact
Account id of the contact
Company id of the contact
Labels applied to the contact
Full serialized contact record returned when the public API renders a Contact model directly.
{
"id": 0,
"uuid": "string",
"inbox_id": 0,
"contact_last_seen_at": 0,
"status": "open",
"agent_last_seen_at": 0,
"messages": [
{
"id": 0,
"content": "string",
"message_type": 0,
"content_type": "string",
"content_attributes": {},
"created_at": 0,
"conversation_id": 0,
"attachments": [
{
"id": 0,
"message_id": 0,
"file_type": "image",
"account_id": 0,
"extension": "string",
"data_url": "string",
"thumb_url": "string",
"file_size": 0,
"width": 0,
"height": 0,
"coordinates_lat": 0,
"coordinates_long": 0,
"fallback_title": "string",
"meta": {},
"transcribed_text": "string"
}
],
"sender": {
"id": 0,
"name": "string",
"avatar_url": "string",
"thumbnail": "string",
"type": "contact",
"available_name": "string",
"availability_status": "string",
"email": "string",
"phone_number": "string",
"identifier": "string",
"blocked": true,
"additional_attributes": "Unknown Type: object,null",
"custom_attributes": "Unknown Type: object,null",
"description": "string",
"created_at": "string"
}
}
],
"contact": {
"id": 0,
"name": "string",
"email": "string",
"phone_number": "string",
"identifier": "string",
"blocked": true,
"additional_attributes": "Unknown Type: object,null",
"custom_attributes": "Unknown Type: object,null",
"contact_type": "string",
"country_code": "string",
"last_activity_at": "string",
"created_at": "string",
"updated_at": "string",
"last_name": "string",
"middle_name": "string",
"location": "string",
"account_id": 0,
"company_id": 0,
"label_list": [
"string"
]
}
}