Look up a phone number
Describes a phone number and returns its carrier from a carrier lookup when the number is valid.
Describes a phone number and returns its carrier from a carrier lookup when the number is valid.
Describes the number from numbering-plan data and, for a valid number, adds carrier information from a live
carrier lookup. A number without the international shape gives 400 / 10001; a number its country does not
assign returns 200 with isValid: false and carrier: null, without a carrier lookup. Returns
503 / 10007 when the carrier lookup is unavailable. The carrier is for display only and nothing is stored; use
search to find a sellable operator.
PartnerApiKeyX-Partner-Key<token>Partner API Key (X-Partner-Key)
phoneNumber*stringThe number in international format, starting with + or 00; spaces, hyphens and parentheses are allowed.
OK
- response
What a phone number's own digits say about it, from numbering-plan data, plus carrier data from a carrier lookup.
phoneNumber is the number in E.164. isValid is false when the digits do not form a
number its country assigns; the other fields then hold whatever could still be read, and lineType is
unknown. countryCode is ISO 3166-1 alpha-2, null when the number belongs to no single country.
dialCode is the calling code with its leading plus. The formats are for display only.
carrier comes from a carrier lookup made only for a valid number; it is null for an invalid one.
phoneNumber*stringisValid*booleancountryCode?string|nulldialCode*stringnationalNumber*stringinternationalFormat*stringnationalFormat*stringlineType*string"unknown""mobile""fixedLine""fixedLineOrMobile""tollFree""premiumRate""sharedCost""voip""personalNumber""pager""uan""voicemail"carrier?|Carrier information from the number lookup. name may identify the original number-block
owner when portability data is unavailable; it does not guarantee the current carrier after porting.
normalizedName is the reported parent network when
known. lineType is the carrier's view of the line. isPorted is null when the lookup does
not say, which is common outside the US. For display only: the operator OpenRoam sells for a number comes from search.
curl -X GET 'https://api.sandbox.openroam.com/v1/airtime/number-lookup?phoneNumber=%2B994501234567'{ "phoneNumber": "string", "isValid": true, "countryCode": "string", "dialCode": "string", "nationalNumber": "string", "internationalFormat": "string", "nationalFormat": "string", "lineType": "unknown", "carrier": { "name": "string", "normalizedName": "string", "lineType": "unknown", "isPorted": true }}List airtime operators GET
Lists the operators of a country that the customer can choose manually (manual flow, step 1). Returns the complete list, without paging or prices, as `{ items: [{ id, name, countryCode, category, logoUrl }] }`, ordered by name. Only operators with an offer that can be sold for a chosen operator are listed. An invalid `countryCode` gives 400 / 10001. Continue with `operators/{id}?phoneNumber=`.
Quote airtime POST
Prices the order body with current prices, without placing an order. Takes the same body as order and resolves the number's operator as the order does, with a carrier lookup per item. Each item is priced on its own, in request order; the first failing item aborts the quote and is named at `items[i]`, for example 409 / 11002 at `items[i].inputs.maxPrice` when the current price is above it. 409 / 20000 means the lookup shows that the offer's operator cannot be the number's: search again. A carrier lookup that fails gives 503 / 10007. A quote reserves nothing and does not expire; to hold the quoted price, send it as `inputs.maxPrice` in the order.