Phone Numbers

List Phone Numbers

Get a list of phone numbers registered to an account.

get/v4/accounts/{voip_id}/phone-numbers

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/phone-numbers
  • Auth: HTTP bearer

Path parameters

voip_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

include_subaccountsinteger

Send "1" if you want to add subaccounts data into output

filters[name]string

Name filter

filters[number]string

Phone number filter

filters[did]string

DID (number) filter

filters[activation_date]string

Activation date filter

filters[has_real_route]string

1 for phone numbers with meaningful routes (not just 'disconnect'); 0 for other extensions.

filters[lrdn_numbers]string

By default we don't show system LRDN numbers. If you want to get LRDN numbers only, provide "only" as value. If you want to include LRDN numbers, provide "include" as value.

filters[usage]string

Filters results based onthe way number uses the extension: "voip" (number should use extension in the call handling rules), "sms" (number should use extension as inbox), "any". Works only for extension-level requests.

filters[name-or-did]string

Search by Phone number name or DID (number)

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.