Premiers pasPhone Numbers

List Phone Numbers Page

Retrieve a page of Phone Numbers

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

page_sizeintegerOptionnel1-1000Par défaut 100
Number of phone numbers per page
searchstringOptionnel<=100 characters

Filter by phone number ID, label, or phone number. A phone number ID must match exactly; label and phone number matching is a case-insensitive substring.

labelstringOptionnel<=100 characters

Filter by label. Matching is a case-insensitive substring.

phone_numberstringOptionnel<=100 characters
Filter by phone number
providerenumOptionnel
Filter by telephony provider
Valeurs autorisées:
supports_outboundbooleanOptionnel
Filter by whether the phone number can place outbound calls
agent_idstringOptionnel
Filter by assigned agent ID
branch_idstringOptionnel
Filter by assigned branch ID
sort_byenumOptionnel
The field to sort the results by
Valeurs autorisées:
sort_directionenumOptionnel
The direction to sort the results
Valeurs autorisées:
cursorstringOptionnel
Used for fetching next page. Cursor is returned in the response.

Réponse

Successful Response
phone_numberslist of objects
The phone numbers on this page
next_cursorstringOptionnel

Pass this value as cursor to fetch the next page. Null when there are no more results.

has_morebooleanOptionnelPar défaut false
Whether there are more results available

Erreurs

422
Phone Numbers List V2request Unprocessable Entity Error