List account phone numbers
GET https://api.plivo.com/v1/Account/{{auth_id}}/Number/?limit=5&offset=0
Returns a list of phone numbers that you’ve rented from Plivo or added from your carrier.
Below is the list of arguments that can be passed in this API request, more information can be found here
| Arguments | Description | Required/Conditional/Optional |
|---|---|---|
| type | The type of number. You can filter by local, mobile, fixed, national and tollfree numbers. | Optional |
| number_startswith | Only show the phone numbers that begin with this pattern. | Optional |
| subaccount | Returns phone numbers associated to this sub account. | Optional |
| alias | Returns phone numbers that exactly match this alias. | Optional |
| services | Filters phone numbers which provide the selected services . Possible values are: voice: Indicates that phone numbers which can receive calls are to be returned. sms: Indicates that phone numbers which can receive SMS are to be returned. mms: Indicates that phone numbers that can receive MMS are to be returned. voice,sms: Indicates that phone numbers which can receive both calls and SMS are to be returned. voice,sms,mms: Indicates that phone numbers that can receive calls, SMS and MMS are to be returned. | Optional |
| 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. Defaults to 0. Read more about offset based pagination here. | Optional |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type | string | The type of number. You can filter by local, mobile, fixed, national and tollfree numbers. | |
number_startswith | number | Only show the phone numbers that begin with this pattern. | |
subaccount | string | Returns phone numbers associated to this sub account. | |
alias | string | Returns phone numbers that exactly match this alias. | |
services | string | Filters phone numbers which provide the selected services | |
limit | number | Used to display the number of results per page. The maximum number of results that can be fetched is 20. Defaults to 20. | |
offset | number | Denotes the number of value items by which the results should be offset. Defaults to 0 |