Accesskey5

Activeflow5

Agent11

AI34

Auth8

Billing12

Call24

Campaign14

Case10

Conference14

Contact17

Conversation11

Customer13

Email4

Extension8

Flow6

Groupcall5

Interaction2

Me1

Message4

Number9

Outdial11

Outplan6

Provider6

ProviderCall4

Queue13

RAG7

Recording4

Route5

Service Agent66

ServiceAgent9

Speaking7

Storage10

Tag5

Team6

Timeline8

Transcribe6

Transfer1

Trunk5

Webchat15

Websocket1

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"
}

Changes

Changed in 4 of the 54 revisions of this API.1715

Jul 26, 2026d5569b3154112See the full diff
- ●
  added the new web_session enum value to the destination/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new web_session enum value to the source/type response property for the response status 200
  response-property-enum-value-added
Jun 27, 20266ac21a841bca2See the full diff
- ○
  added the optional property destination to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property source to the response with the 200 status
  response-optional-property-added
Jun 26, 2026c7eb634e776f76See the full diff
- ●
  added the new enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new done enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new email enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new line enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new message enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new progressing enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new whatsapp enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ○
  removed the call enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the campaign enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the none enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the received enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the sending enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the sent enum value from the status response property for the response status 200
  response-property-enum-value-removed
May 30, 2026995c56ba921987See the full diff
- ●
  removed the optional property destination from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property source from the response with the 200 status
  response-optional-property-removed
- ●
  added the new call enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new campaign enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new none enum value to the reference_type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new received enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new sending enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new sent enum value to the status response property for the response status 200
  response-property-enum-value-added
- ○
  removed the enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the done enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the email enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the line enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the message enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the progressing enum value from the status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the whatsapp enum value from the reference_type response property for the response status 200
  response-property-enum-value-removed
This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history