Skip to navigation
API OverviewMessages

Send an outbound SMS message

View as Markdown

Send one SMS synchronously through the configured provider to an Israeli (+972) destination. The monthly quota charges one unit per started 70 Unicode code points of text (1–70 uses one unit; 71–140 uses two). The full text is sent unchanged. Before sending, contact us to approve your outbound sender identity as required by law. A 202 response confirms provider queue acceptance, not carrier handoff or recipient delivery.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Headers

Idempotency-KeystringRequiredformat: "^[A-Za-z0-9._-]{1,128}$"

Request

This endpoint expects an object.
channelenumRequired
Allowed values:
contentobjectRequired
fromstringRequired
tostringRequiredformat: "^\+[1-9]\d{1,14}$"

Canonical E.164 destination. Only Israeli numbers (+972) are supported.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.

Response

The provider accepted the SMS into its queue.
channelenum
Allowed values:
created_atdatetime
delivery_statusenum

pending means the monitoring window remains open without a conclusive outcome.

Allowed values:
directionenum
Allowed values:
message_uuidstring

Message identifier starting with msg_.

sending_statusenum

Latest confirmed sending milestone. queued means the provider accepted the message.

Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error