Skip to main content

message

idnumber

The ID of the message

contentstring

The text content of the message

account_idnumber

The ID of the account

inbox_idnumber

The ID of the inbox

conversation_idnumber

The ID of the conversation

message_typeinteger

The type of the message

Possible values: [0, 1, 2, 3]

created_atinteger

The time at which message was created

updated_atinteger | string

The time at which message was updated

privateboolean

The flags which shows whether the message is private or not

statusstring | nullnullable

The status of the message

Possible values: [sent, delivered, read, failed, null]

source_idstring | nullnullable

The source ID of the message

content_typestring | nullnullable

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]

content_attributesobject

The content attributes for each content_type

sender_typestring | nullnullable

The type of the sender

Possible values: [Contact, User, AgentBot, Assistant, null]

sender_idnumber | nullnullable

The ID of the sender

external_source_idsobject

The external source IDs of the message

additional_attributesobject

The additional attributes of the message

processed_message_contentstring | nullnullable

The processed message content

sentimentobject | nullnullable

The sentiment of the message

conversationobject | nullnullable

The conversation object

attachmentobject | nullnullable

The file object attached to the image

senderobject

User/Agent/AgentBot object

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": {}
}