The Thread object

A thread represents a messaging conversation between Voxity and an individual customer within external channels like Facebook and Instagram.

{
  "id": "2IvanDv3RSQsESRqVKeL",
  "agentId": "1R7kHmQ6moHuhpaddTf9",
  "customerId": "N7adUrMXvVnH5ZN7cDTK",
  "from": {
    "channel": "facebook",
    "id": "25950932307884313"
  },
  "status": "active",
  "aiResponseStatus": "enabled",
  "createdAt": "2024-08-20T15:50:00Z",
  "updatedAt": "2024-08-20T15:50:00Z",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": ""
        }
      ],
      "createdAt": "2025-11-11T15:48:32.594Z"
    },
    {
      "role": "assistant",
      "content": [
        {
          "type": "text",
          "text": ""
        }
      ],
      "createdAt": "2025-11-11T15:48:33.699Z"
    },
  ]
}

Attributes

• id (string) — Unique identifier for the thread.

• agentId (string) — ID of the agent assigned to this thread.

• customerId (string) — ID of the customer associated with the thread.

• from (object) — Origin of the message thread:

  • channel (string) — Communication channel (facebook, instagram, whatsapp, widget_chatbot).

  • id (string) — The channel-specific ID of the user.

• status (string) — "active" or "inactive".

• createdAt (string, ISO 8601) — Thread creation time.

• updatedAt (string, ISO 8601) — Last update time.

• metadata (object) — Additional thread data:

  • conversation (array) — List of messages:

    • role (string) — "user" or "assistant".

    • content (string) — Message text.

    • media (array) — Optional media attached to the message:

      • url (string) — URL of the media file.

      • contentType (string) — MIME type of the media.

      • size (number) — File size in bytes.

    • createdAt (string, ISO 8601) — Time the message was added.

• expanded (object, optional) — Related data:

  • customer (object) — Customer details.

  • opportunities (array) — Open opportunities linked to the customer.