List Conversations

List all conversations in an account with pagination (page size = 25).

Settings:

URL	https://online.99digital.co.il/api/v1/accounts/{account_id}/conversations
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

Query Parameters:

Parameter	type	Description	Required
page	integer	paginate through conversations. Default: `1`	no
assignee_type	string	Filter conversations by assignee type. Enum: `"me"` `"unassigned"` `"all"` `"assigned"` Default: `"all"`	no
status	string	Filter by conversation status. Enum: `"open"` `"resolved"` `"pending"` `"snoozed"` Default: `"open"`	no
q	string	Filter conversations with messages containing the search term.	no
inbox_id	integer	Filter conversations by inbox.	no
team_id	integer	Filter conversations by team.	no
labels	Array of strings	Filter conversations by labels.	no

Response:

{
  "data": {
    "meta": {
      "mine_count": 0,
      "new_count": 0,
      "assigned_count": 0,
      "unassigned_count": 0,
      "all_count": 0
    },
    "payload": [
      {
        "meta": {
          "sender": {
            "additional_attributes": {},
            "availability_status": "offline",
            "email": "string",
            "id": 0,
            "name": "string",
            "phone_number": "string",
            "identifier": "string",
            "thumbnail": "string",
            "custom_attributes": {
              "avatar_img_url": "string"
            },
            "last_activity_at": 0,
            "blocked": false,
            "created_at": 0
          },
          "channel": "string",
          "hmac_verified": false
        },
        "id": 0,
        "messages": [
          {
            "id": 0,
            "content": "string",
            "account_id": 0,
            "inbox_id": 0,
            "conversation_id": 0,
            "message_type": 0,
            "created_at": 0,
            "updated_at": "string",
            "private": false,
            "status": "sent",
            "source_id": "string",
            "content_type": "string",
            "content_attributes": {},
            "sender_type": "Contact",
            "sender_id": 0,
            "external_source_ids": {},
            "additional_attributes": {},
            "label_list": null,
            "created_at_exact": "string",
            "conversation": {
              "assignee_id": 0,
              "unread_count": 0
            },
            "sender": {
              "additional_attributes": {},
              "custom_attributes": {},
              "email": "string",
              "id": 0,
              "identifier": "string",
              "name": "string",
              "phone_number": "string",
              "thumbnail": "string",
              "type": "contact"
            }
          }
        ],
        "account_id": 0,
        "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": false,
        "snoozed_until": 0,
        "status": "open",
        "created_at": 0,
        "timestamp": 0,
        "first_reply_created_at": 0,
        "unread_count": 0,
        "last_non_activity_message": {}
      }
    ]
  }
}

Response-Explain:

Parameter	Description
data	Object containing the response data
data -> meta	Object containing conversations metadata
data -> meta -> mine_count	The number of conversations assigned to the user API key
data -> meta -> new_count	The number of new conversations
data -> meta -> assigned_count	The number of assigned conversations
data -> meta -> unassigned_count	The number of unassigned conversations
data -> meta -> all_count	The number of all conversations
data -> payload	Array of objects (conversation)
data -> payload -> id	Conversation numeric id
data -> payload -> status	The status of the conversation Enum: `"open"` `"resolved"` `"pending"` `"snoozed"`
data -> payload -> messages	Array of objects (message)
data -> payload -> messages -> id	Message numeric id
data -> payload -> messages -> content	The text content of the message
data -> payload -> messages -> account_id	Account numeric id
data -> payload -> messages -> inbox_id	Inbox numeric id
data -> payload -> messages -> conversation_id	Conversation numeric id
data -> payload -> messages -> message_type	The type of the message Enum: `"incoming"` `"outgoing"` `"activity"` `"template"`
data -> payload -> messages -> created_at	The time at which message was created
data -> payload -> messages -> updated_at	The time at which message was updated ISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ)
data -> payload -> messages -> private	Whether the message is private or not
data -> payload -> messages -> status	The status of the message Enum: `"failed"` `"sent"` `"delivered"` `"read"`
data -> payload -> messages -> source_id
data -> payload -> messages -> content_type	The type of the template message Enum: `"text"` `"input_select"` `"cards"` `"form"`
data -> payload -> messages -> content_attributes	Object containing the content attributes for each content_type
data -> payload -> messages -> sender_type	Sender type (contact\user)
data -> payload -> messages -> sender_id	Sender numeric id
data -> payload -> messages -> external_source_ids
data -> payload -> messages -> additional_attributes	Object containing additional attributes related to the message
data -> payload -> messages -> label_list
data -> payload -> messages -> created_at_exact	The time at which message was created (ISO 8601 format)
data -> payload -> messages -> conversation
data -> payload -> messages -> conversation -> assignee_id	The id of the agent or team to whom the conversation is assigned
data -> payload -> messages -> conversation -> unread_count	The number of unread messages
data -> payload -> messages -> sender	Object containing the sender data (contact\agent)
data -> payload -> messages -> sender -> additional_attributes	Object containing additional attributes related to the sender
data -> payload -> messages -> sender -> custom_attributes	Object containing custom attributes related to the sender
data -> payload -> messages -> sender -> email	Sender email address
data -> payload -> messages -> sender -> id	Sender numeric id
data -> payload -> messages -> sender -> identifier	A unique identifier for the sender in external system
data -> payload -> messages -> sender -> name	Sender name
data -> payload -> messages -> sender -> phone_number	Sender phone number
data -> payload -> messages -> sender -> thumbnail	Avatar URL
data -> payload -> messages -> sender -> type	Sender type (contact\user)
data -> payload -> account_id	Account numeric id
data -> payload -> inbox_id	Inbox numeric id
data -> payload -> labels	Array of strings (label)
data -> payload -> unread_count	The number of unread messages
data -> payload -> contact_last_seen_at	The last time a contact interacted with your service
data -> payload -> can_reply	Whether the conversation is currently within messaging window
data -> payload -> muted	Whether the conversation is currently muted
data -> payload -> snoozed_until	The time at which previously snoozed conversation is reactivated
data -> payload -> assignee_last_seen_at	The last time at which the assignee (user) was available
data -> payload -> agent_last_seen_at	The last time at which the agent was available
data -> payload -> additional_attributes	The object containing additional attributes related to the conversation
data -> payload -> custom_attributes	The object containing custom attributes for conversation (custom attributes key and value)
data -> payload -> created_at	The time at which conversation was created
data -> payload -> first_reply_created_at	The time at which the first reply was sent
data -> payload -> last_non_activity_message	Object containing last non-activity message (incoming, outgoing, template)
data -> payload -> attachments
data -> payload -> meta	Object containing the conversation metadata
data -> payload -> meta -> channel	Channel type
data -> payload -> meta -> hmac_verified
data -> payload -> meta -> sender	Object containing the contact data
data -> payload -> meta -> sender -> id	Contact numeric id
data -> payload -> meta -> sender -> name	Contact name
data -> payload -> meta -> sender -> phone_number	Contact phone number
data -> payload -> meta -> sender -> email	Contact email address
data -> payload -> meta -> sender -> identifier	A unique identifier for the contact in external system
data -> payload -> meta -> sender -> availability_status	Availability status of the contact
data -> payload -> meta -> sender -> thumbnail	Avatar URL
data -> payload -> meta -> sender -> last_activity_at	Timestamp of the last activity
data -> payload -> meta -> sender -> blocked	Whether the contact is blocked
data -> payload -> meta -> sender -> created_at	Timestamp of contact creation time
data -> payload -> meta -> sender -> additional_attributes	Object containing additional attributes related to the contact
data -> payload -> meta -> sender -> custom_attributes	Object containing custom attributes related to the contact

Created with the Personal Edition of HelpNDoc: Full-featured EPub generator