Send an SMS to an eSIM
Sends a text message to one of your eSIMs.
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.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
iccid*stringThe eSIM's ICCID, from the order item's fulfillment.result.details.iccid.
The message to send.
- body
A text message to send to an eSIM; the ICCID comes from the route.
message*stringThe message text; required and not empty.
OK
- response
The answer to POST /esims/{id}/sms, given only when the message was sent.
iccid*stringThe ICCID of the eSIM the message was sent to.
curl -X POST 'https://api.sandbox.openroam.com/v1/esims/8944501234567890123/sms' \ -H 'Content-Type: application/json' \ -d '{ "message": "string"}'{ "iccid": "string"}Search eSIM plans GET
Searches eSIM destinations and returns them with their plans, one page at a time. Returns `{ items, pagination }`. `countryCode` keeps the destinations whose coverage includes that country, so local, regional and global destinations can match; `category` and `region` select destinations, and `validityDays` and `isUnlimited` select plans within them. Pages count destinations with an orderable plan. With `iccid` it returns the plans that can top up that eSIM instead, under its destination, and takes no filter other than `currency` (400 / 10001, `NOT_ALLOWED`); an unknown or foreign ICCID gives 404 / 10004. Prices are indicative, in `currency`.
Airtime catalog GET
Returns the operator directory, page by page, for partner inventory. Returns `{ items: [{ id, name, countryCode, category, logoUrl }], nextCursor }`, ordered by operator ID. Pass `nextCursor` back as `cursor` with the same `countryCode` until it is null; a page can hold fewer items than `limit`, and the cursor does not expire. A cursor reused with another `countryCode`, or a blank or invalid `countryCode`, gives 400 / 10001. Offers are not exported: they depend on whether the operator is detected or chosen, so read them with `operators/{id}?phoneNumber=`.