Airtime catalog
Returns the operator directory, page by page, for partner inventory.
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=.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
countryCode?stringOptional ISO 3166-1 alpha-2 country filter, in either case; every country when omitted. A blank or invalid value gives 400 / 10001.
cursor?stringThe nextCursor of the previous page; omit it for the first page. Reuse it only with the same countryCode.
limit?integerPage size, 1 to 100; default 100.
int32OK
- response
A page of the operator directory, ordered by operator ID. Continue with nextCursor and the same
filters until it is null; a page may hold fewer items than the limit.
items*array<>nextCursor?string|nullcurl -X GET 'https://api.sandbox.openroam.com/v1/airtime/catalog?countryCode=AZ&limit=10'{ "items": [ { "id": "string", "name": "string", "countryCode": "string", "category": "string", "logoUrl": "string" } ], "nextCursor": "string"}Send an SMS to an eSIM POST
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.
Order airtime POST
Places an airtime top-up order and returns the accepted order. Takes the same body as quote and needs the `manage` order permission (403 / 10003 without it). An `Idempotency-Key` header with a new UUID is required for every purchase: a retry with the same key and body returns the order already accepted, 409 / 12002 with `Retry-After` while it is still being accepted, and a changed body gives 409 / 12001. The number's operator is looked up again, as in quote; item errors are named at `items[i]`, and a current price above `inputs.maxPrice` gives 409 / 11002 before anything is charged. Track fulfillment with the order routes or the `order.fulfillment.updated` webhook. A wallet charge that fails creates no order and gives 402 / 16000, with `details[0]` naming `wallet` and `INSUFFICIENT_BALANCE` or `WALLET_BLOCKED`; send the same request with the same key after a top-up.