API ReferenceConversations

Create conversation and send message

Send to an existing conversation (conversation_id) or create/find by channel_type + channel_user_id. Supports whatsapp, webchat, telephony (test and live where configured).

POST
/api/v1/console/agents/{agentId}/conversations/messages

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/console/agents/string/conversations/messages" \  -H "Content-Type: application/json" \  -d '{    "message": "string"  }'
{  "message": "Success",  "data": {    "id": "string",    "role": "string",    "message": "string",    "message_type": "string",    "created_at": "2019-08-24T14:15:22Z",    "attachments": [      {        "type": "image",        "url": "http://example.com"      }    ]  }}