Skip to Content
OpenRoam Docs
eSIMs

Send an SMS to an eSIM

Sends a text message to one of your eSIMs.

POST
/v1/esims/{iccid}/sms

Sends a text message to one of your eSIMs.

Takes { message }, which must not be empty, and returns { iccid } only when the message was sent. An eSIM whose plan cannot be sent messages this way gives 422 / 22000 (ESIM_SMS_NOT_SUPPORTED); do not retry it. A message that was not sent gives 502 / 10008. An ICCID that is not one of your eSIMs gives 404 / 10004.

Authorization

PartnerApiKey
headerX-Partner-Key<token>

Partner API Key (X-Partner-Key)

Path Parameters

iccid*string

The eSIM's ICCID, from the order item's fulfillment.result.details.iccid.

Request Body

The message to send.

  1. body

A text message to send to an eSIM; the ICCID comes from the route.

message*string

The message text; required and not empty.

Response Body

OK

  1. response

The answer to POST /esims/{id}/sms, given only when the message was sent.

iccid*string

The ICCID of the eSIM the message was sent to.

Example Request
curl -X POST 'https://api.sandbox.openroam.com/v1/esims/8944501234567890123/sms' \  -H 'Content-Type: application/json' \  -d '{  "message": "string"}'
Example Response
{  "iccid": "string"}