Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Conversation

Send a message

Sends a message to a specific conversation and returns the sent message info.

post/conversations/{id}/messages

Path parameters

idstring required

The ID of the conversation.

Request body

textstring required

The message text.

Example request

{
  "medias": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "type": "image",
      "filename": "photo_2026-01-15.jpg",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}

Response

idstring uuid

The unique identifier of the message.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

conversation_idstring uuid

The unique identifier of the conversation. Returned from the GET /conversations response.

direction'outgoing' | 'incoming'

Direction of the message (incoming or outgoing).

status'progressing' | 'done' | 'failed'

Delivery status of the message.

reference_type'' | 'message' | 'line' | 'whatsapp' | 'email'

Source channel that produced the message.

reference_idstring uuid

The unique identifier of the referenced resource. The actual resource type is determined by reference_type. Returned from the corresponding resource endpoint.

textstring

The message 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",
  "conversation_id": "550e8400-e29b-41d4-a716-446655440000",
  "direction": "incoming",
  "status": "done",
  "reference_type": "message",
  "reference_id": "f6a7b8c9-d0e1-2345-6789-0abcdef01234",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "text": "Hello, how can I help you today?",
  "medias": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "type": "image",
      "filename": "photo_2026-01-15.jpg",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_update": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ],
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}