/restapi/v1.0/number-pool/lookup
POST {{baseUrl}}/restapi/v1.0/number-pool/lookup?areaCode=<integer>&countryCode=<string>&countryId=<string>&exclude=<string>&extendedSearch=<boolean>&line=<string>&numberPattern=<string>&nxx=<string>&npa=<string>&paymentType=<string>&perPage=<integer>&smsEnabled=<boolean>
Look up Phone Number
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
areaCode | string | Area code of the location | |
countryCode | string | Two-letter country code, complying with the ISO standard | |
countryId | string | Internal identifier of a country; '1'- the US; '39' - Canada; '224' - the UK. The default value is '1' | |
exclude | string | A string of digits (one and more) that should not appear among the last four digits (line part) of the phone numbers that will be returned. It is possible to specify several exclude parameters. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified) | |
extendedSearch | string | If the value is 'False', then the returned numbers exactly correspond to the specified NXX, NPA and LINE or countryCode, areaCode and numberPattern parameters. If the value is 'True', then the resulting numbers are ranked and returned with the rank attribute values (1-10). The default value is 'False' | |
line | string | LINE pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 4 characters) | |
numberPattern | string | Phone number pattern (for wildcard or vanity search). For NANP countries (US, Canada) is concatenation of nxx (the first three digits) and line. If the first three characters are specified as not digits (e.g. 5** or CAT) then parameter extendedSearch will be ignored. | |
nxx | string | NXX pattern for vanity or wildcard search. Digits, Latin characters and asterisks are allowed (usually 3 characters) | |
npa | string | Area code (mandatory). For example, 800, 844, 855, 866, 877, 888 for North America; and 647 for Canada | |
paymentType | string | Payment type. Default is 'Local' (it should correlate with the npa provided) | |
perPage | string | Indicates the page size (number of items). If not specified, the value is '10' by default | |
smsEnabled | string | Specifies if SMS activation is available for the number. If specified, it is taken into account in all returned phone numbers both in the phone numbers satisfying to parameters of lookup and in alternative phone numbers (in case when extendedSearch is specified). If not specified, the value is null. |