POST
/
v1
/
message

This API endpoint allows you to send an SMS message to a specified recipient.

Body

to
array
required

A list of phone numbers of the recipient in E.164 international format.

message
string
required

The content of the SMS message.

sim
string

Sim slot id to manage the sending sim in setups with multiple carrier connections. Ignore if your phone only has one sim installed or if you just want to use the default.

metadata
object

Additional metadata associated with the message. This can be used to create powerful two-way messaging applications without having to store persistent data in the application.

Response

message
string

Message of submission attempt.

message_id
array

Array of UUIDs of the messages from submission as it will appear in webhook callbacks and reporting. Ordered to match the destinations of the send request.