Operações básicas para manipulação do agente.
Nos cabeçalhos dos requests, é necessário incluir uma chave "token" cujo valor seja um token de API.
Transferir
|
Endpoint |
/api/v1/calls/{call_uuid}/transfer |
|
Method |
POST |
Corpo do JSON
|
Campo |
Descrição |
Padrão |
|
destination_number |
Número de destino. |
- |
|
leg |
Leg que será transferida. Os possíveis valores são: "aleg" e "bleg". Quando o valor é "bleg" será transferiada a bridged leg. |
bleg |
Exemplo de requisição
curl -X POST \
https://example.callwe.io/api/v1/calls/<CALL_UUID>/transfer \
-H 'Content-Type: application/json' \
-H 'token: <EVOLUX_TOKEN>'
-d '{"destination_number": "<DESTINATION_NUMBER>"}'
Exemplo de respostas
{
"meta": {
"status": 200,
"message": "OK"
}
}
Desligar chamada
|
Endpoint |
/api/v1/calls/{call_uuid}/hangup |
|
Method |
POST |
Parâmetros
|
skip_survey |
É possível ignorar a pesquisa da fila/campanha se enviar este parâmetro com o valor igual a "true". Se a pesquisa for obrigatória este parâmetro será ignorado. Caso não seja enviado a chamada será desligada de acordo com o comportamento da pesquisa. |
O corpo da requisição deverá ser vazio.
Exemplo da requisição
curl -X POST \
https://example.callwe.io/api/v1/calls/<CALL_UUID>/hangup?skip_survey=true \
-H 'Content-Type: application/json' \
-H 'token: <CALLWE_TOKEN>'
Exemplos de respostas
{
"meta": {
"status": 200,
"message": "OK"
}
}
{
"meta": {
"status": 404,
"message": "Not found"
},
"errors": {
"call_uuid": "This call does not exist"
}
}