Skip to navigation

Usando a API para realizar chamadas (Click to Call)

Para iniciar chamadas automáticas usando a API é preciso utilizar a interface do sistema para gerar um
token de acesso da API.

1. Iniciar uma chamada

Este endpoint permite iniciar uma chamada automática para um número específico através de um usuário/agente do sistema.

Exemplo de chamada:

curl -X POST "https://sua-conta.callix.com.br/api/v1/click_to_call" \
-H "Authorization: Bearer SEU_TOKEN" \
-H "Content-Type: application/vnd.api+json" \
-d '{
"data": {
"type": "click_to_call",
"attributes": {
"user_id": "1",
"phone": "18997405083"
}
}
}'

Na chamada, você deve fornecer:

  • user_id: ID do agente que realizará a chamada
  • phone: Número de telefone de destino (formato nacional ou internacional)

Exemplo de resposta:

{
"click_to_call_id": "654ab628-d964-4dc4-9beb-5defafe82d38",
"message": "Call successfully sent"
}

O campo click_to_call_id é um identificador único gerado para rastrear a chamada no sistema.

Atributos

Atributos da Requisição

AtributoTipoObrigatórioDescrição
user_idstringSimID do agente que realizará a chamada
phonestringSimNúmero de telefone de destino

Atributos da Resposta

AtributoTipoDescrição
click_to_call_idstringID único gerado para identificar a chamada
messagestringMensagem confirmando o sucesso da operação

Códigos de Resposta

Código HTTPDescrição
200Chamada enviada com sucesso
400Requisição inválida (campos obrigatórios ausentes ou formato incorreto)
401Token de autenticação inválido ou ausente
404Usuário não encontrado