Skip to main content

public_message

idinteger

Id of the message

contentstring | nullnullable

Text content of the message. Can be null for attachment-only messages.

message_typeinteger

Denotes the message type. Possible values: 0 (incoming), 1 (outgoing), 2 (activity), 3 (template)

content_typestring

Content type of the message

content_attributesobject

Additional content attributes of the message

created_atinteger

Created at Unix timestamp of the message

conversation_idinteger

Display Id of the conversation the message belongs to

attachments object[]

Attachments if any

  • Array [
  • idinteger

    Id of the attachment

    message_idinteger

    Id of the parent message

    file_typestring

    Type of the attached file

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

    account_idinteger

    Id of the account

    extensionstring | nullnullable

    File extension

    data_urlstring | nullnullable

    URL of the file. Can be null when an attachment variant has no external URL.

    thumb_urlstring

    URL of the file thumbnail

    file_sizeinteger

    File size in bytes

    widthinteger | nullnullable

    Width of the attachment when available

    heightinteger | nullnullable

    Height of the attachment when available

    coordinates_latnumber

    Latitude for location attachments

    coordinates_longnumber

    Longitude for location attachments

    fallback_titlestring | nullnullable

    Fallback title for location, fallback, and contact attachments when available

    metaobject

    Metadata for contact attachments

    transcribed_textstring

    Transcribed text for audio attachments

    property name*any

    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.

    idinteger

    Id of the sender

    namestring | nullnullable

    Name of the sender when available

    avatar_urlstring

    Avatar URL of the sender. Present for senders of type user, agent_bot, and assistant. Not present for contact senders (use thumbnail instead).

    thumbnailstring

    Avatar/thumbnail URL of the sender. Contact senders use this field; user senders may also include it.

    typestring

    Type of the sender

    Possible values: [contact, user, agent_bot, assistant]

    available_namestring | nullnullable

    Display name for user senders

    availability_statusstring | nullnullable

    Availability status for user senders

    emailstring | nullnullable

    Email of the sender when the sender is a contact

    phone_numberstring | nullnullable

    Phone number of the sender when the sender is a contact

    identifierstring | nullnullable

    Identifier of the sender when the sender is a contact

    blockedboolean

    Whether the sender is blocked when the sender is a contact

    additional_attributesobject | nullnullable

    Additional attributes when the sender is a contact and available

    custom_attributesobject | nullnullable

    Custom attributes when the sender is a contact and available

    descriptionstring | nullnullable

    Description when the sender is a assistant assistant

    created_atstring | nullnullable

    Created timestamp in ISO 8601 format when the sender is a assistant assistant

    property name*any

    Polymorphic sender payload returned by push_event_data. Available fields vary by sender type.

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