Skip to main content
POST
Send a message to a phone number

Authorizations

x-api-key
string
header
required

Body

application/json
phone
string
required
Minimum string length: 1
channelId
string
required
Minimum string length: 1
method
string
required
Allowed value: "MESSAGES"
messages
string · object · object · object · object · object · object · object · object · object[]
required

Sent in order, one after the other. Each is a text, or a typed message (text or media: IMAGE, VIDEO, AUDIO, DOCUMENT, ...) as MESSAGE takes it; messageIds answers one id per item, in the same order.

Minimum array length: 1
Minimum string length: 1
contactId
string
Minimum string length: 1
deliveryTimeoutMs
integer

Automations only: how long the calling step waits to hear how the send went. A message still queued by then is not sent, and the step is told it failed with DELIVERY_TIMEOUT.

Required range: 1 <= x <= 86400000

Response

Success

chatId
string
required
Minimum string length: 1
messageIds
string[]
required

Ids the queued messages will be stored under, in order. Empty for AI, which writes its own.

Minimum string length: 1
delivery
enum<string>
required

REPORTED when the calling automation step will be told how the send went.

Available options:
REPORTED,
NOT_REPORTED