Sign in
Messages
Esims

Send an SMS through one eSIM

post/numbers/esims/{id}/messages

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Request body

tostring required

Recipient phone number — normalized to E.164 (spaces/dashes/dots stripped); rejected with 400 if it doesn't validate as E.164 afterward.

bodystring required

SMS body text (max 320 chars — smaller than the admin tier's cap; see the schema's own doc comment for why)

clientRequestIdstring

Client-supplied idempotency key, scoped to (owner, esimId, key). Replaying the same key + identical payload returns the original send; the same key with a DIFFERENT payload is a 409 conflict.

deliveryReportboolean

Wait for physedge to confirm carrier delivery before completing the send (adds executor-side latency, never on this request — sends are always async/202). Defaults to false for the public tier (opt-in, unlike the admin tier's default-true).

Example request

{
  "to": "+15551230001"
}

Response

Outbound message queued

Changes