VocalDocscontracts 1.65.0

List the Phone numbers of the Organization

GET /v1/phone-numbers

PropertyValue
Operationlist_phone_numbers
GroupPhone numbers
Scopetelephony:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; a Phone number is the Organization's own number, not Call content.
Released in1.22.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Newest first, with keyset pagination (1.22.0). Every status is listed, so a released number stays visible to its Organization.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the telephony:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/phone-numbers" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.

Responses

StatusContent typeShapeError codes
200application/jsonPhoneNumberList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is PhoneNumberList.

FieldTypeRequiredDescription
dataarray of PhoneNumberyesThe Phone numbers of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes