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:
POST
Params
Authorization
Body
| Key | Value |
|---|
var axios = require("axios").default; var options = { method: 'POST', url: 'https://exemplo.callix.com.br/api/v1/click_to_call', headers: { 'Content-Type': 'application/json', Authorization: 'Bearer {seu_token }'} }; axios.request(options).then(function (response) { console.log(response.data); }).catch(function (error) { console.error(error); });
Para testar, configure na página de Autenticação.
Na chamada, você deve fornecer:
user_id: ID do agente que realizará a chamadaphone: 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
| Atributo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | string | Sim | ID do agente que realizará a chamada |
phone | string | Sim | Número de telefone de destino |
Atributos da Resposta
| Atributo | Tipo | Descrição |
|---|---|---|
click_to_call_id | string | ID único gerado para identificar a chamada |
message | string | Mensagem confirmando o sucesso da operação |
Códigos de Resposta
| Código HTTP | Descrição |
|---|---|
200 | Chamada enviada com sucesso |
400 | Requisição inválida (campos obrigatórios ausentes ou formato incorreto) |
401 | Token de autenticação inválido ou ausente |
404 | Usuário não encontrado |
Last updated on