# Requisição 1: Obter todos os números de telefone
curl -X GET "https://app.talkover.ai/api/v1/phone-numbers" \
  -H "Authorization: Bearer talq_your_environment_token_here"

{
  "success": true,
  "data": [
    {
      "id": "phone-uuid-1",
      "number": "+5511987654321",
      "country_code": "US",
      "formatted_number": "(123) 456-7890",
      "international_number": "+1 234 567 890",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    },
    {
      "id": "phone-uuid-2",
      "number": "+5511976543210",
      "country_code": "US",
      "formatted_number": "(987) 654-3210",
      "international_number": "+1 987 654 321",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    }
  ]
}

GET

api

phone-numbers

# Requisição 1: Obter todos os números de telefone
curl -X GET "https://app.talkover.ai/api/v1/phone-numbers" \
  -H "Authorization: Bearer talq_your_environment_token_here"

{
  "success": true,
  "data": [
    {
      "id": "phone-uuid-1",
      "number": "+5511987654321",
      "country_code": "US",
      "formatted_number": "(123) 456-7890",
      "international_number": "+1 234 567 890",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    },
    {
      "id": "phone-uuid-2",
      "number": "+5511976543210",
      "country_code": "US",
      "formatted_number": "(987) 654-3210",
      "international_number": "+1 987 654 321",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    }
  ]
}

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

GET /api/v1/phone-numbers

Cabeçalhos da requisição

Authorization

string

obrigatório

Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

Parâmetros de consulta

type

string

Filtrar por tipo de número de telefone. Opções: voice, sms, whatsapp, mms, fax

has_voice

boolean

Filtrar por capacidade de voz. Opções: true, false

has_whatsapp

boolean

Filtrar por capacidade de WhatsApp. Opções: true, false

string

Pesquisar por número de telefone ou ID

Exemplos de Requisição

# Requisição 1: Obter todos os números de telefone
curl -X GET "https://app.talkover.ai/api/v1/phone-numbers" \
  -H "Authorization: Bearer talq_your_environment_token_here"

# Requisição 2: Obter números com capacidade de voz
curl -X GET "https://app.talkover.ai/api/v1/phone-numbers?has_voice=true" \
  -H "Authorization: Bearer talq_your_environment_token_here"

# Requisição 3: Pesquisar por número específico
curl -X GET "https://app.talkover.ai/api/v1/phone-numbers?search=+5511987654321" \
  -H "Authorization: Bearer talq_your_environment_token_here"

Resposta

Resposta de Sucesso (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "phone-uuid-1",
      "number": "+5511987654321",
      "country_code": "US",
      "formatted_number": "(123) 456-7890",
      "international_number": "+1 234 567 890",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    },
    {
      "id": "phone-uuid-2",
      "number": "+5511976543210",
      "country_code": "US",
      "formatted_number": "(987) 654-3210",
      "international_number": "+1 987 654 321",
      "type": "voice",
      "has_voice": true,
      "has_sms": true,
      "has_mms": false,
      "has_fax": false,
      "has_whatsapp": false,
      "current_status": "active",
      "is_sandbox": false,
      "current_price": 1.00,
      "currency": "USD",
      "renewal_date": "2024-02-15",
      "auto_renewal": true,
      "created_at": "2024-01-15T11:00:00Z",
      "updated_at": "2024-01-15T11:00:00Z",
      "monthly_renewal_cost": 1.00,
      "days_until_monthly_renewal": 15,
      "is_due_for_monthly_renewal": false,
      "environment": null,
      "agents": null
    }
  ]
}

Campos da Resposta

success

boolean

obrigatório

Indica se a operação foi bem-sucedida.

data

array

obrigatório

Array de objetos de número de telefone.

Mostrar Objeto de Número de Telefone

string

obrigatório

Identificador único do número de telefone.

number

string

obrigatório

Número de telefone em formato E.164.

country_code

string

obrigatório

Código do país do número.

formatted_number

string

obrigatório

Número formatado para exibição.

international_number

string

obrigatório

Número internacional formatado.

type

string

obrigatório

Tipo do número de telefone. Opções: voice, sms, whatsapp, mms, fax.

has_voice

boolean

obrigatório

Se o número tem capacidade de voz.

has_sms

boolean

obrigatório

Se o número tem capacidade de SMS.

has_mms

boolean

obrigatório

Se o número tem capacidade de MMS.

has_fax

boolean

obrigatório

Se o número tem capacidade de fax.

has_whatsapp

boolean

obrigatório

Se o número tem capacidade de WhatsApp.

current_status

string

obrigatório

Status atual do número. Opções: active, inactive, pending, suspended.

is_sandbox

boolean

obrigatório

Se o número é um número de sandbox.

current_price

number

obrigatório

Preço atual do número.

currency

string

obrigatório

Moeda do preço.

renewal_date

string

obrigatório

Data de renovação (YYYY-MM-DD).

auto_renewal

boolean

obrigatório

Se a renovação automática está ativada.

created_at

string

obrigatório

Timestamp ISO 8601 quando o número foi criado.

updated_at

string

obrigatório

Timestamp ISO 8601 quando o número foi atualizado pela última vez.

monthly_renewal_cost

number

obrigatório

Custo mensal de renovação.

days_until_monthly_renewal

integer

obrigatório

Dias até a renovação mensal.

is_due_for_monthly_renewal

boolean

obrigatório

Se o número está vencendo para renovação mensal.

environment

object

Informações do ambiente (quando carregado).

agents

array

Agentes associados (quando carregado).

Respostas de erro

401 Não Autorizado

{
  "success": false,
  "message": "Unauthorized"
}

422 Erro de Validação

{
  "success": false,
  "message": "The given data was invalid.",
  "errors": {
    "type": [
      "The selected type is invalid."
    ]
  }
}

500 Erro do Servidor

{
  "success": false,
  "message": "Internal server error."
}

Códigos de erro

Código	Descrição	Status HTTP
`INVALID_TOKEN`	Token de autenticação inválido ou ausente	401
`VALIDATION_ERROR`	Validação dos parâmetros de consulta falhou	422
`SERVER_ERROR`	Erro interno do servidor ocorreu	500

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

Filtre por capacidades - Use has_voice e has_whatsapp para encontrar números adequados
Verifique status - Certifique-se de que os números estão ativos antes de usar
Monitore renovação - Acompanhe as datas de renovação para evitar interrupções
Pesquise eficientemente - Use o parâmetro search para encontrar números específicos
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

Gerar Demonstração de Voz Listar Solicitações de Liberação

​Listar Números de Telefone

​Endpoint

​Cabeçalhos da requisição

​Parâmetros de consulta

​Exemplos de Requisição

​Resposta

​Resposta de Sucesso (200 OK)

​Campos da Resposta

​Respostas de erro

​401 Não Autorizado

​422 Erro de Validação

​500 Erro do Servidor

​Códigos de erro

​Notas Importantes

​Melhores Práticas

​Endpoints relacionados

Listar Números de Telefone

Endpoint

Cabeçalhos da requisição

Parâmetros de consulta

Exemplos de Requisição

Resposta

Resposta de Sucesso (200 OK)

Campos da Resposta

Respostas de erro

401 Não Autorizado

422 Erro de Validação

500 Erro do Servidor

Códigos de erro

Notas Importantes

Melhores Práticas

Endpoints relacionados