Skip to main content

contact_conversations

array of conversations

  • Array [
  • idnumber

    ID of the conversation

    messages object[]
  • Array [
  • 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

  • ]
  • account_idnumber

    Account Id

    uuidstring

    UUID of the conversation

    additional_attributesobject

    The object containing additional attributes related to the conversation

    agent_last_seen_atnumber

    The last activity at of the agent

    assignee_last_seen_atnumber

    The last activity at of the assignee

    can_replyboolean

    Whether the conversation can be replied to

    contact_last_seen_atnumber

    The last activity at of the contact

    custom_attributesobject

    The object to save custom attributes for conversation, accepts custom attributes key and value

    inbox_idnumber

    ID of the inbox

    labelsstring[]

    The labels of the conversation

    mutedboolean

    Whether the conversation is muted

    snoozed_untilnumber | nullnullable

    The time at which the conversation will be unmuted

    statusstring

    The status of the conversation

    Possible values: [open, resolved, pending]

    created_atnumber

    The time at which conversation was created

    updated_atnumber

    The time at which conversation was updated

    timestampnumber

    The time at which conversation was created

    first_reply_created_atnumber | nullnullable

    The time at which the first reply was created

    unread_countnumber

    The number of unread messages

    last_non_activity_message object

    The last non activity message

    oneOf
    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

    last_activity_atnumber

    The last activity at of the conversation

    prioritystring | nullnullable

    The priority of the conversation

    waiting_sincenumber | nullnullable

    The time at which the conversation was waiting

    sla_policy_idnumber | nullnullable

    The ID of the SLA policy

    applied_slaobject

    The applied SLA

    sla_eventsobject[]
    meta object
    sender object
    additional_attributesobject

    The additional attributes of the sender

    availability_statusstring

    The availability status of the sender

    emailstring | nullnullable

    The email of the sender

    idnumber

    ID fo the sender

    namestring

    The name of the sender

    phone_numberstring | nullnullable

    The phone number of the sender

    blockedboolean

    Whether the sender is blocked

    identifierstring | nullnullable

    The identifier of the sender

    thumbnailstring | nullnullable

    Avatar URL of the contact

    custom_attributesobject

    The custom attributes of the sender

    last_activity_atnumber

    The last activity at of the sender

    created_atnumber

    The created at of the sender

    channelstring

    Channel Type

    assignee object
    idnumber
    access_tokenstring
    account_idnumber
    available_namestring
    avatar_urlstring
    confirmedboolean
    display_namestring | nullnullable
    message_signaturestring | nullnullable
    emailstring
    hmac_identifierstring
    inviter_idnumber | nullnullable
    namestring
    providerstring
    pubsub_tokenstring
    rolestring

    Possible values: [agent, administrator]

    ui_settingsobject
    uidstring
    typestring | nullnullable
    custom_attributesobject

    Available for users who are created through platform APIs and has custom attributes associated.

    accounts object[]
  • Array [
  • idnumber
    namestring
    statusstring
    active_at(string | null)<date-time>nullable
    rolestring

    Possible values: [administrator, agent]

    permissionsstring[]
    availabilitystring
    availability_statusstring
    auto_offlineboolean
    custom_role_idnumber | nullnullable
    custom_roleobject | nullnullable
  • ]
  • hmac_verifiedboolean

    Whether the hmac is verified

    display_idnumber
  • ]
  • contact_conversations
    [
    {
    "id": 0,
    "messages": [
    {
    "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": {}
    }
    ],
    "account_id": 0,
    "uuid": "string",
    "additional_attributes": {},
    "agent_last_seen_at": 0,
    "assignee_last_seen_at": 0,
    "can_reply": true,
    "contact_last_seen_at": 0,
    "custom_attributes": {},
    "inbox_id": 0,
    "labels": [
    "string"
    ],
    "muted": true,
    "snoozed_until": 0,
    "status": "open",
    "created_at": 0,
    "updated_at": 0,
    "timestamp": 0,
    "first_reply_created_at": 0,
    "unread_count": 0,
    "last_non_activity_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": {}
    },
    "last_activity_at": 0,
    "priority": "string",
    "waiting_since": 0,
    "sla_policy_id": 0,
    "applied_sla": {},
    "sla_events": [
    {}
    ],
    "meta": {
    "sender": {
    "additional_attributes": {},
    "availability_status": "string",
    "email": "string",
    "id": 0,
    "name": "string",
    "phone_number": "string",
    "blocked": true,
    "identifier": "string",
    "thumbnail": "string",
    "custom_attributes": {},
    "last_activity_at": 0,
    "created_at": 0
    },
    "channel": "string",
    "assignee": {
    "id": 0,
    "access_token": "string",
    "account_id": 0,
    "available_name": "string",
    "avatar_url": "string",
    "confirmed": true,
    "display_name": "string",
    "message_signature": "string",
    "email": "string",
    "hmac_identifier": "string",
    "inviter_id": 0,
    "name": "string",
    "provider": "string",
    "pubsub_token": "string",
    "role": "agent",
    "ui_settings": {},
    "uid": "string",
    "type": "string",
    "custom_attributes": {},
    "accounts": [
    {
    "id": 0,
    "name": "string",
    "status": "string",
    "active_at": "2024-07-29T15:51:28.071Z",
    "role": "administrator",
    "permissions": [
    "string"
    ],
    "availability": "string",
    "availability_status": "string",
    "auto_offline": true,
    "custom_role_id": 0,
    "custom_role": "Unknown Type: object,null"
    }
    ]
    },
    "hmac_verified": true
    },
    "display_id": 0
    }
    ]