List all Numbers
GET https://api.plivo.com/v1/Account/{{auth_id}}/NumberPool/{number_pool_uuid}/Number/?starts_with=&type=&service=&country_iso2=&limit=&offset=
This API can be used to fetch a list of numbers from the Number Pool based on numberpoolUUID specified in the resource URI. More information can be found here
| Arguments | Description | Required/Conditional/Optional |
|---|
| starts_with | A comma separated list of prefixes. Assume the values provided exclude the country code prefix. A max of 10 prefixes may be specified. Throw 400 Bad Request if more than 10 prefixes are specified. | Optional |
| type | fixed, tollfree or mobile. Note that local and national numbers should be considered as ‘fixed’ | Optional |
| service | sms or mms. Use this argument to filter the numbers by capability. | Optional |
| country_iso2 | ISO2 code of the phone number country. This attribute must be specified if starts_with filter has been specified. | Conditional |
| limit | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. | Optional |
| offset | Denotes the number of value items by which the results should be offset. | Optional |
Request Params
| Key | Datatype | Required | Description |
|---|
starts_with | null | | A comma separated list of prefixes. |
| Assume the values provided exclude the country code prefix. | | | |
| A max of 10 prefixes may be specified. | | | |
type | null | | fixed, tollfree or mobile. Note that local and national numbers should be considered as ‘fixed’ |
service | null | | sms or mms. Use this argument to filter the numbers by capability. |
country_iso2 | null | | ISO2 code of the phone number country. |
| This attribute must be specified if starts_with filter has been specified. | | | |
limit | null | | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. |
offset | null | | Denotes the number of value items by which the results should be offset |