AXaxilioai
messages

Send a message

Changed on

Sends a message from one of your dedicated phones: an SMS when parts is one text part, an MMS when it carries media from your file library. The phone must have outbound messaging enabled by your administrator. Returns 202 with the message, queued; the outcome arrives as a message.sent or message.failed webhook and is readable at GET /messages/{message_id}. A phone that never received the message within about 15 minutes (it is offline, say) fails it rather than sending it late; one that received it but has not reported back by then makes it unconfirmed until it does. Each phone sends at most 15 messages per 30 minutes. Reusing an idempotency_key returns the original message, as it is now, instead of sending again; reusing it for a different message is a 409.

post/messages

Request

Request body

$schemastring uri

A URL to the JSON Schema for this object.

idempotency_keystring required

A caller-chosen key; the same key for your organization sends at most once.

phone_idstring required

The dedicated phone to send from, by its public id.

tostring[] nullable required

The recipients, as E.164 numbers such as +14155550123. One recipient for now.

Example request

{
  "$schema": "/api/v1/SendMessageInputBody.json"
}

Response

Accepted

$schemastring uri

A URL to the JSON Schema for this object.

accepted_atstring date-time

When the phone reported it had this outgoing message. Absent for a received message, and for one the phone never got.

api_key_idstring

The API key that sent this message. Absent for a message a signed-in user sent, a received message, and one sent before senders were recorded.

bodystring required

The message text: every text part, in order, joined with a newline. Empty for a message with no text.

channel'sms' | 'mms' | 'rcs' required

How the message travelled: sms (plain text), mms (multimedia, including group texts and some long texts), or rcs. More channels may be added; treat a value you don't know as a channel you don't handle.

conversation_idstring required

The conversation this message is in: GET /conversations/{conversation_id} reads it, and its messages are at GET /conversations/{conversation_id}/messages.

created_atstring date-time required

When the platform stored the message. Lists sort and filter on this time.

deleted_atstring date-time

When the message was deleted. Present only on a deleted message, which GET /messages/{message_id} still returns with no body or parts; lists and conversations leave it out.

delivered_atstring date-time

When a message this phone sent was delivered. Absent until then, and for a received message.

direction'inbound' | 'outbound' required

inbound for a message the phone received, outbound for one it sent.

errorstring

Why an outbound message failed or is unconfirmed, in words. Empty otherwise.

error_code'phone_unreachable' | 'no_result' | 'policy_off' | 'expired' | 'no_subscription' | 'no_service' | 'radio_off' | 'carrier_rejected' | 'phone_rate_limited' | 'media_fetch_failed' | 'connection_lost' | 'queue_full' | 'send_failed'

Why an outbound message failed or is unconfirmed, as a code to branch on: phone_unreachable (the phone never got it before its deadline; it did not go out), no_result (unconfirmed: the phone had it but has not reported), policy_off (the phone's sending switch is off), expired (its deadline passed before the phone could send it), no_subscription (no SIM line), no_service (no mobile service or data), radio_off, carrier_rejected, phone_rate_limited (Android's outgoing-message limit on the phone), media_fetch_failed (the phone could not download the attachment), connection_lost (the phone lost its connection before sending; it did not go out), queue_full (the phone was too busy), or send_failed (any other failure; error has the detail). Empty when error is. Absent on a failure reported by older phone software.

failed_atstring date-time

When a message this phone sent failed. Absent unless its status is failed.

fromstring nullable required

Sender: an E.164 number, a short code, or an alphanumeric sender id. Null only when the sender is this phone's own SIM and the phone does not know its number.

idstring required

Message identifier.

is_groupboolean required

True for a group message (more than one recipient).

phone_idstring required

The phone that received or sent the message.

received_atstring date-time nullable required

When this phone received the message, by the phone's clock, to the millisecond. Null for a message the phone sent.

sent_atstring date-time nullable required

When the message was sent. For a received message, the sending network's clock (SMS carries whole seconds); for a message this phone sent, when the platform learned the network accepted it. Null for a message not sent yet.

status'queued' | 'sent' | 'delivered' | 'failed' | 'unconfirmed'

The delivery state of a message this phone sent: queued (accepted and issued to the phone), sent (the network accepted it), delivered (the recipient acknowledged it), failed, or unconfirmed (the phone had it but has not reported whether it went out; do not resend automatically, it may still turn sent or failed). Empty for a received message. More statuses may be added; treat one you don't know as still in progress.

tostring[] nullable required

Every recipient, as E.164 numbers. For a one-to-one inbound message this is the phone's own number; a group message lists every recipient. Empty when the only recipient is this phone's own SIM and the phone does not know its number.

truncatedboolean required

True when the text was longer than 5000 characters and was cut to that length.

user_idstring

The signed-in user who sent this message, from the dashboard or the CLI. Absent for a message sent with an API key, a received message, and one sent before senders were recorded.

Example response

{
  "$schema": "/api/v1/PhoneMessage.json"
}

Changes