List of Messages

List of all messages in a conversation.

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages
Method	JSON via GET

Authorization:

Header Parameter	Description
api_access_token	user API key

The user API key provides access to endpoints based on the user permissions levels and can be obtained by visiting the profile page.

Path Parameters:

Parameter	Description	Required
account_id	The numeric id of the account	yes
conversation_id	The numeric id of the conversation	yes

Response:

{
  "meta": {
    "labels": ["string"],
    "additional_attributes": {},
    "contact": {
      "additional_attributes": {},
      "custom_attributes": {
        "avatar_img_url": "string"
      },
      "email": "string",
      "id": 0,
      "identifier": "string",
      "name": "string",
      "phone_number": "string",
      "thumbnail": "string",
      "type": "contact"
    },
    "agent_last_seen_at": "string",
    "assignee_last_seen_at": "string"
  },
  "payload": [
    {
      "id": 0,
      "content": "string",
      "inbox_id": 0,
      "conversation_id": 0,
      "message_type": 0,
      "content_type": "text",
      "status": "sent",
      "content_attributes": {},
      "created_at": 0,
      "private": false,
      "source_id": "string",
      "sender": {
        "additional_attributes": {},
        "custom_attributes": {
          "avatar_img_url": "string"
        },
        "email": "string",
        "id": 0,
        "identifier": "string",
        "name": "string",
        "phone_number": "string",
        "thumbnail": "string",
        "type": "contact"
      },
      "created_at_exact": "string"
    }
  ]
}

Response-Explain:

Parameter	Description
meta	An object containing metadata about the conversation
meta -> labels	A list of labels associated with the conversation
meta -> contact	An object containing data about the contact related to the conversation
meta -> contact -> id	Contact numeric id
meta -> contact -> name	The contacts name
meta -> contact -> phone_number	The contacts phone number
meta -> contact -> email	The contacts email address
meta -> contact -> identifier	A unique identifier for the contact in external system
meta -> contact -> thumbnail	Avatar URL of the contact
meta -> contact -> additional_attributes	An object containing additional attributes associated with the contact
meta -> contact -> custom_attributes	An object containing the different custom attributes associated with the contact
meta -> contact -> type	Contact type (contact\user)
meta -> agent_last_seen_at	The last time at which the agent was available (ISO 8601 format)
meta -> assignee_last_seen_at	The last time at which an assignee was available (ISO 8601 format)
meta -> additional_attributes	An object containing additional attributes related to the conversation
payload
payload -> id	Message numeric id
payload -> content	The message text content
payload -> inbox_id	Inbox numeric id
payload -> conversation_id	Conversation numeric id
payload -> message_type	The type of the message 1 - incoming 2 - outgoing 3 - activity 4 - template
payload -> content_type	The type of the template message Enum: `"text"` `"input_select"` `"cards"` `"form"` `"article"` Default: `"text"`
payload -> status	The status of the message Enum: `"failed"` `"sent"` `"delivered"` `"read"`
payload -> content_attributes	An object containing content attributes for the content_type
payload -> created_at	The time at which message was created (Unix timestamp)
payload -> private	A Boolean indicating whether the message is private or not
payload -> source_id	Message source id
payload -> attachments	An array of objects (attachment)
payload -> attachments -> id	File numeric id
payload -> attachments -> message_id	Message numeric id
payload -> attachments -> file_type	The type of file Enum: `"image"` `"video"` `"audio"` `"file"` `"location"` `"contact"` `"share"` `"story_mention"`
payload -> attachments -> account_id	Account numeric id
payload -> attachments -> extension
payload -> attachments -> data_url	File URL
payload -> attachments -> thumb_url
payload -> attachments -> file_size	The file size
payload -> sender	An object containing sender data (contact \ user \ agent_bot)
payload -> sender -> id	Sender id
payload -> sender -> name	Sender name
payload -> sender -> phone_number	Sender phone number
payload -> sender -> email	Sender email address
payload -> sender -> identifier	A unique identifier for the contact in external system
payload -> sender -> type	Sender type (contact \ user \ agent_bot)
payload -> sender -> thumbnail	Avatar URL
payload -> sender -> custom_attributes	An object containing custom attributes related to the sender
payload -> sender -> additional_attributes	An object containing additional attributes related to the sender
payload -> created_at_exact	The time at which message was created (ISO 8601 format)

Created with the Personal Edition of HelpNDoc: Write EPub books for the iPad