Primeros pasosPhone Numbers

List Phone Numbers Page

Retrieve a page of Phone Numbers

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

page_sizeintegerOpcional1-1000Valor predeterminado: 100
Number of phone numbers per page
searchstringOpcional<=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.

labelstringOpcional<=100 characters

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

phone_numberstringOpcional<=100 characters
Filter by phone number
providerenumOpcional
Filter by telephony provider
Valores permitidos:
supports_outboundbooleanOpcional
Filter by whether the phone number can place outbound calls
agent_idstringOpcional
Filter by assigned agent ID
branch_idstringOpcional
Filter by assigned branch ID
sort_byenumOpcional
The field to sort the results by
Valores permitidos:
sort_directionenumOpcional
The direction to sort the results
Valores permitidos:
cursorstringOpcional
Used for fetching next page. Cursor is returned in the response.

Respuesta

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

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

has_morebooleanOpcionalValor predeterminado: false
Whether there are more results available

Errores

422
Phone Numbers List V2request Unprocessable Entity Error