Pierwsze krokiPhone Numbers

List Phone Numbers Page

Retrieve a page of Phone Numbers

Nagłówki

xi-api-keystringOpcjonalny

Parametry zapytania

page_sizeintegerOpcjonalny1-1000Domyślnie 100
Number of phone numbers per page
searchstringOpcjonalny<=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.

labelstringOpcjonalny<=100 characters

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

phone_numberstringOpcjonalny<=100 characters
Filter by phone number
providerenumOpcjonalny
Filter by telephony provider
Dozwolone wartości:
supports_outboundbooleanOpcjonalny
Filter by whether the phone number can place outbound calls
agent_idstringOpcjonalny
Filter by assigned agent ID
branch_idstringOpcjonalny
Filter by assigned branch ID
sort_byenumOpcjonalny
The field to sort the results by
Dozwolone wartości:
sort_directionenumOpcjonalny
The direction to sort the results
Dozwolone wartości:
cursorstringOpcjonalny
Used for fetching next page. Cursor is returned in the response.

Odpowiedź

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

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

has_morebooleanOpcjonalnyDomyślnie false
Whether there are more results available

Błędy

422
Phone Numbers List V2request Unprocessable Entity Error