Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
conversations
/
{conversation_id}
/
messages
Get messages
curl --request GET \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'api_access_token: <api-key>'
{
  "meta": {
    "labels": [
      "<string>"
    ],
    "additional_attributes": {},
    "contact": {
      "payload": [
        {
          "additional_attributes": {},
          "availability_status": "<string>",
          "email": "<string>",
          "id": 123,
          "name": "<string>",
          "phone_number": "<string>",
          "blocked": true,
          "identifier": "<string>",
          "thumbnail": "<string>",
          "custom_attributes": {
            "attribute_key": "attribute_value",
            "signed_up_at": "dd/mm/yyyy"
          },
          "last_activity_at": 123,
          "created_at": 123,
          "contact_inboxes": [
            {
              "source_id": "<string>",
              "inbox": {
                "id": 123,
                "avatar_url": "<string>",
                "channel_id": 123,
                "name": "<string>",
                "channel_type": "<string>",
                "provider": "<string>"
              }
            }
          ]
        }
      ]
    },
    "assignee": {
      "id": 123,
      "account_id": 123,
      "auto_offline": true,
      "confirmed": true,
      "email": "<string>",
      "available_name": "<string>",
      "name": "<string>",
      "thumbnail": "<string>",
      "custom_role_id": 123
    },
    "agent_last_seen_at": "2023-11-07T05:31:56Z",
    "assignee_last_seen_at": "2023-11-07T05:31:56Z"
  },
  "payload": [
    {
      "id": 123,
      "content": "<string>",
      "account_id": 123,
      "inbox_id": 123,
      "conversation_id": 123,
      "created_at": 123,
      "updated_at": 123,
      "private": true,
      "source_id": "<string>",
      "content_attributes": {},
      "sender_id": 123,
      "external_source_ids": {},
      "additional_attributes": {},
      "processed_message_content": "<string>",
      "sentiment": {},
      "conversation": {},
      "attachment": {},
      "sender": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

​
conversation_id
integer
required

The numeric ID of the conversation

Query Parameters

​
after
integer

Fetch messages after the message with this ID. Returns up to 100 messages in ascending order.

​
before
integer

Fetch messages before the message with this ID. Returns up to 20 messages in ascending order.

Response

Success

​
meta
object
​
payload
object[]

Array of messages