Saltar a la navegación
Primeros pasosPhone Numbers

Listar página de números de teléfono

Obtiene una página de números de teléfono

Encabezados

xi-api-keystringOpcional

Parámetros de consulta

page_sizeintegerOpcional1-1000Valor predeterminado: 100

Número de números de teléfono por página

searchstringOpcional<=100 characters

Filtra por ID de número de teléfono, etiqueta o número de teléfono. El ID del número de teléfono debe coincidir exactamente; la coincidencia de etiqueta y número de teléfono es una subcadena sin distinción entre mayúsculas y minúsculas.

labelstringOpcional<=100 characters

Filtra por etiqueta. La coincidencia se realiza con una subcadena sin distinguir entre mayúsculas y minúsculas.

phone_numberstringOpcional<=100 characters

Filtra por número de teléfono

providerenumOpcional

Filtra por proveedor de telefonía

Valores permitidos:
supports_outboundbooleanOpcional

Filtra según si el número de teléfono puede realizar llamadas salientes

agent_idstringOpcional
Filtra por ID de agente asignado
branch_idstringOpcional
Filtra por ID de rama asignada
sort_byenumOpcional

El campo por el que se ordenarán los resultados

Valores permitidos:
sort_directionenumOpcional

La dirección para ordenar los resultados

Valores permitidos:
cursorstringOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.
phone_numberslist of objects

Los números de teléfono de esta página

next_cursorstringOpcional

Pasa este valor como cursor para obtener la página siguiente. Null cuando no hay más resultados.

has_morebooleanOpcionalValor predeterminado: false

Indica si hay más resultados disponibles

Errores

422
Phone Numbers List V2request Unprocessable Entity Error