v1

latestOpenAPI 3.1.02026-07-12113560.7 KB

Messages

Send Message

post/unified/messaging/messages

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

contentstring nullable

Content body of the message

recipientstring nullable

Can be a conversation ID, user ID, email or phone number.

senderstring nullable

The account_id or phone number of the message sender

Example request

{
  "content": "Hello, world!",
  "recipient": "c28xyrc55866bvuv",
  "sender": "+34820398402"
}

Response

The message was sent successfully.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}