Skip to main content
GET

Listar Números de Telefone

Recuperar uma lista de números de telefone disponíveis com opções de filtragem por tipo, capacidades e status.

Endpoint

Cabeçalhos da requisição

string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

Parâmetros de consulta

string
Filtrar por tipo de número de telefone. Opções: voice, sms, whatsapp, mms, fax
boolean
Filtrar por capacidade de voz. Opções: true, false
boolean
Filtrar por capacidade de WhatsApp. Opções: true, false
Pesquisar por número de telefone ou ID

Exemplos de Requisição

Resposta

Resposta de Sucesso (200 OK)

Campos da Resposta

boolean
obrigatório
Indica se a operação foi bem-sucedida.
array
obrigatório
Array de objetos de número de telefone.

Respostas de erro

401 Não Autorizado

422 Erro de Validação

500 Erro do Servidor

Códigos de erro

Notas Importantes

Capacidades de filtragem. Use parâmetros de consulta para filtrar números por tipo e capacidades.
Formato de números. Todos os números são retornados em formato E.164.
Informações de renovação. Inclui detalhes sobre custos e datas de renovação.

Melhores Práticas

  1. Filtre por capacidades - Use has_voice e has_whatsapp para encontrar números adequados
  2. Verifique status - Certifique-se de que os números estão ativos antes de usar
  3. Monitore renovação - Acompanhe as datas de renovação para evitar interrupções
  4. Pesquise eficientemente - Use o parâmetro search para encontrar números específicos
  5. Trate erros - Implemente tratamento adequado de erros para falhas de autenticação e validação

Endpoints relacionados

  • Listar Modelos de Voz: GET /api/v1/voice-templates
  • Gerar Demonstração de Voz: GET /api/v1/voice-templates/{voice_template_id}/demo