Skip to main content
POST

Realizar uma Chamada

Inicia uma chamada com IA usando um agente de voz específico. Este endpoint cria uma nova chamada e retorna os detalhes da chamada, incluindo um ID de chamada único. Para chamadas baseadas em campanha, veja Realizar Chamada de Campanha.

Endpoint

Parâmetros de caminho

string
obrigatório
O identificador único do agente de voz que tratará a chamada.

Cabeçalhos da requisição

string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here
string
obrigatório
Deve ser definido como application/json

Corpo da requisição

string
obrigatório
Número de telefone para chamar. Deve estar em formato internacional (ex: +5511987654321).
object
Variáveis de substituição para o prompt do agente. Use isto para personalizar a conversa com dados dinâmicos. As chaves devem corresponder a placeholders no prompt do seu agente.
object
Dados customizados a serem enviados de volta ao seu cliente via webhooks. Estes dados não são usados na conversa, mas serão incluídos em todos os eventos de webhook relacionados a esta chamada, permitindo que você acompanhe e associe chamadas aos seus registros internos.
integer
padrão:"0"
Número de segundos para atrasar antes de realizar a chamada. Faixa: 03600 (1 hora). Útil para agendar uma chamada alguns segundos ou minutos após um evento gatilho.
boolean
padrão:"false"
Quando true, a chamada é marcada como um teste. Chamadas de teste não consomem créditos de cobrança e são excluídas das agregações de analytics.

Exemplos

Resposta

Resposta de Sucesso (200 OK)

Campos da Resposta

boolean
obrigatório
Indica se a requisição foi processada com sucesso.
string
obrigatório
Identificador único da chamada. Use este ID para acompanhar o status da chamada, recuperar detalhes ou correlacionar com eventos de webhook.
string
O ID do agente de voz que está tratando a chamada.
string
obrigatório
O número de telefone que foi chamado.
string
obrigatório
Status atual da chamada. Valores possíveis:
  • initiated - Chamada foi criada e está sendo processada
  • ringing - Telefone está tocando
  • answered - Chamada está ativa e a conversa está acontecendo
  • completed - Chamada finalizou com sucesso
  • failed - Chamada falhou
  • busy - Telefone estava ocupado
  • no-answer - Telefone tocou mas não foi atendido
string
obrigatório
Timestamp ISO 8601 quando a chamada foi criada.

Respostas de erro

400 Requisição Inválida

401 Não Autorizado

404 Não Encontrado

402 Pagamento Necessário

429 Muitas Requisições

Códigos de erro

Limites de taxa

Cabeçalhos de limite de taxa são incluídos em todas as respostas:
  • X-RateLimit-Limit: Máximo de requisições por janela
  • X-RateLimit-Remaining: Requisições restantes na janela atual
  • X-RateLimit-Reset: Hora em que o limite de taxa é redefinido

Melhores Práticas

  1. Sempre trate erros graciosamente — verifique respostas de erro e implemente lógica de retry com backoff exponencial.
  2. Armazene IDs de chamada — use o data.id retornado para acompanhar o status da chamada e correlacionar com eventos de webhook.
  3. Use context para rastreamento — passe IDs internos em context para que eventos de webhook possam ser vinculados aos registros do seu sistema.
  4. Use is_testing durante a integração — mantém o tráfego de teste fora dos analytics e evita cobrança.
  5. Valide números de telefone antes de chamar — garanta o formato E.164 (+ seguido de código do país e número).

Endpoints relacionados