Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

channelId
string
required

The unique identifier of the channel.

Example:

"6633a1b2c4d5e6f7a8b9c0d1"

Body

application/json
recipient
object
required

The message recipient.

text
string

The text message body. Mutually exclusive with template.

Example:

"Your order has been confirmed."

template
object

The template message content. Mutually exclusive with text.

Response

200 - application/json

Successfully created a message.

name
string
required

The resource name of the message.

Example:

"channels/6633a1b2c4d5e6f7a8b9c0d1/conversations/664fa2b3c4d5e6f7a8b9c0d2/messages/665ab3c4d5e6f7a8b9c0d3e4"

createTime
string<date-time>
required

The timestamp when the message was created.

Example:

"2026-04-03T10:00:00Z"

status
enum<string>
required

The delivery status of the message.

Available options:
SENDING,
SENT,
DELIVERED,
READ,
FAILED
Example:

"SENDING"

contentType
enum<string>
required

The content type of the message.

Available options:
TEXT,
TEMPLATE
Example:

"TEXT"

text
string

The text content. Present when contentType is TEXT.

Example:

"Your order has been confirmed."

template
object

The template content. Present when contentType is TEMPLATE.