Skip to main content

message_detailed

idnumber

The ID of the message

contentstring

The text content of the message

inbox_idnumber

The ID of the inbox

conversation_idnumber

The ID of the conversation

message_typeinteger

The type of the message (0: incoming, 1: outgoing, 2: activity, 3: template)

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

content_typestring

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]

statusstring

The status of the message

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

content_attributes object

The content attributes for each content_type

in_reply_tostring | nullnullable

ID of the message this is replying to

echo_idstring | nullnullable

The echo ID of the message, used for deduplication

created_atinteger

The timestamp when message was created

privateboolean

The flag which shows whether the message is private or not

source_idstring | nullnullable

The source ID of the message

sender object
additional_attributes object

The object containing additional attributes related to the contact

citystring

City of the contact

countrystring

Country of the contact

country_codestring | nullnullable

Country code of the contact

created_at_ipstring

IP address when the contact was created

custom_attributesobject

The custom attributes of the contact

emailstring

The email address of the contact

idinteger

The ID of the contact

identifierstring | nullnullable

The identifier of the contact

namestring

The name of the contact

phone_numberstring | nullnullable

The phone number of the contact

thumbnailstring

The thumbnail of the contact

blockedboolean

Whether the contact is blocked

typestring

The type of entity

Possible values: [contact]

attachments object[]

The list of attachments associated with the message

  • Array [
  • idnumber

    The ID of the attachment

    message_idnumber

    The ID of the message

    file_typestring

    The type of the attached file

    Possible values: [image, video, audio, file, location, fallback, share, story_mention, contact, ig_reel]

    account_idnumber

    The ID of the account

    data_urlstring

    The URL of the attached file

    thumb_urlstring

    The thumbnail URL of the attached file

    file_sizenumber

    The size of the attached file in bytes

  • ]
  • message_detailed
    {
    "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
    }
    ]
    }