Create and send an SMS

Create and send an SMS for the workspace identified by the API key.

to_phone_number must be E.164 and must not be on the merge blocklist. A unique
customer match is used, or a customer is created when none match. Optionally provide
from_phone_number to select the Consio number used to send.

The request is validated synchronously, then the message is sent asynchronously:
the response returns the created message before it reaches the provider, so
sent_at and external_status are still null. media_urls attaches files
to the message (MMS); they are downloaded and validated off the request path, and
an unusable attachment marks the message failed instead of failing the request.
Subscribe to the message_failed webhook event (or poll GET /messages/{rid})
to learn the outcome.

The SMS is attributed to user_rid or user_email when given, and to the user
who created the API key otherwise. Either way the message records which API key it
was sent through.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Public API request to create and send an SMS.

string
required
length ≥ 1
string
required
^([0-9]+|c[a-z2-7]{14,31})$

Resource id of the workspace user sending the SMS. Mutually exclusive with user_email. Defaults to the user who created the API key when neither is provided.

Email of the workspace user sending the SMS. Mutually exclusive with user_rid. Defaults to the user who created the API key when neither is provided.

media_urls
array of uris
length ≤ 10

Public HTTPS URLs of files to attach to the message, turning it into an MMS. Each file is downloaded and stored by Consio before the message is sent. At most 10 files, 5 MB combined with the message body; supported types are image, video, audio, and PDF.

Media Urls
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json