Listar página de números de telefone

Recupere uma página de números de telefone

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

page_sizeintegerOpcional1-1000Padrão é 100

Número de telefones por página

searchstring or nullOpcional<=100 characters

Filtre por ID do número de telefone, rótulo ou número de telefone. Um ID de número de telefone deve corresponder exatamente; a correspondência de rótulo e número de telefone considera substrings sem distinção entre maiúsculas e minúsculas.

labelstring or nullOpcional<=100 characters

Filtrar por rótulo. A correspondência é uma substring que não diferencia maiúsculas de minúsculas.

phone_numberstring or nullOpcional<=100 characters

Filtrar por número de telefone

providerenum or nullOpcional
Filtre pelo provedor de telefonia
Valores permitidos:
supports_outboundboolean or nullOpcional

Filtre por números de telefone que podem realizar chamadas de saída

agent_idstring or nullOpcional

Filtrar por ID do agente atribuído

branch_idstring or nullOpcional

Filtrar por ID da ramificação atribuída

sort_byenum or nullOpcional
O campo pelo qual ordenar os resultados
Valores permitidos:
sort_directionenumOpcional

A direção para ordenar os resultados

Valores permitidos:
cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

phone_numberslist of objects

Os números de telefone nesta página

next_cursorstring or nullOpcional

Passe este valor como cursor para buscar a próxima página. Null quando não houver mais resultados.

has_morebooleanOpcionalPadrão é false

Indica se há mais resultados disponíveis

Erros

422
Unprocessable Entity Error