Get Number List

Response Format

ParameterTypeDescription
ServiceIDStringThe service account ID
NumberNumberThe service number. It is only applicable to the service numbers and virtual numbers.
senderIDStringThe sender ID. It is only applicable to the alphanumeric number.
typeStringThe type of the number. The value can be
- TF (Toll-free)
- DID (DID number)
- CUSTOM (Service number)
- ALPHANUMERIC (Alphanumeric number)
countryArray of stringIt indicates which country or region this number originates from. The result is represented in the following format:
(Country represented by Two-letter country code based on ISO 3166-2)
Example: VE. Country=Venezuela.
expireDateStringThe expiry date of the number. It is only applicable to the virtual numbers and alphanumeric numbers.
nameStringThe name of the number. It is only applicable to virtual numbers and service numbers.
Path Params
string
required

App ID

string
required

The type of the numbers you are required to get. It must be "access-numbers" (Virtual Number), "cli" (Service Number) or "sms-numbers" (AlphaNumeric Number).

Query Params
int32
Defaults to 0

Skip the number of the shown data in the response. If the offset value is 10, the first 10 data will be skipped. The default value is 0.

int32
Defaults to 50

The number of data that will be returned, e.g. if the set limit is 10, 10 records will be returned in the response. The maximum value is 500.

Headers
string

application/json

string

Bearer AppToken

Responses

Language
Choose an example:
application/json