Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Service Agent

Create a new talk message

Creates a new talk message and returns the created message's details.

post/service_agents/talk_messages

Request body

chat_idstring required

Talk chat ID.

parent_idstring

Parent message ID for threading (optional).

type'normal' | 'system' required

Type of the message.

textstring required

Message text content.

Example request

{
  "type": "normal",
  "medias": [
    {
      "type": "file",
      "address": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
      "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "link_url": "https://example.com/document.pdf"
    }
  ]
}

Response

The created talk message's details.

idstring uuid

The unique identifier of the message. Returned from the POST /service_agents/talk_messages or GET /service_agents/talk_messages response.

customer_idstring uuid

The unique identifier of the customer who owns this message. Returned from the GET /customers response.

owner_typestring

Resource's owner type.

owner_idstring uuid

The unique identifier of the message author. Returned from the corresponding owner resource endpoint.

chat_idstring uuid

The unique identifier of the talk this message belongs to. Returned from the GET /service_agents/talk_chats response.

parent_idstring uuid

The unique identifier of the parent message (for threaded replies). Returned from the GET /service_agents/talk_messages response.

type'normal' | 'system'

Type of the message.

textstring

Message text content.

tm_createstring date-time

Timestamp when the message was created.

tm_updatestring date-time

Timestamp when the message was last updated.

tm_deletestring date-time

Timestamp when the message was deleted.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "owner_type": "agent",
  "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
  "chat_id": "f6a7b8c9-d0e1-2f3a-4b5c-6d7e8f9a0b1c",
  "parent_id": "a7b8c9d0-e1f2-3a4b-5c6d-7e8f9a0b1c2d",
  "type": "normal",
  "text": "Hello team, any updates on the project?",
  "medias": [
    {
      "type": "file",
      "address": {
        "type": "tel",
        "target": "+14155551234",
        "target_name": "John Smith",
        "name": "Main Office",
        "detail": "Primary contact number"
      },
      "agent_id": "c3d4e5f6-a7b8-9c0d-1e2f-3a4b5c6d7e8f",
      "file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "link_url": "https://example.com/document.pdf"
    }
  ],
  "metadata": {
    "reactions": [
      {
        "emoji": "👍",
        "owner_type": "agent",
        "owner_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
        "tm_create": "2026-01-15T09:30:00.000000Z"
      }
    ]
  },
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-16T14:20:00.000000Z",
  "tm_delete": "2026-01-17T18:45:00.000000Z"
}