Neste documento, explicamos como usar o endpoint /calls/CALL_ID/dial da API apps para ligar para um terceiro e adicioná-lo a uma chamada em andamento. Quando você faz uma
solicitação para esse endpoint, o sistema disca automaticamente o número de telefone
do terceiro, e o adaptador de chamada do agente mostra a tela Chamando. Adicionar
terceiros às chamadas dessa maneira funciona independentemente de o adaptador de chamada
estar em execução na área de trabalho do agente, no CRM ou no
portal da plataforma CCAI. Um agente precisa estar em uma chamada ativa para que esse endpoint
funcione.
Chamar o endpoint
Para adicionar um terceiro a uma chamada, faça uma solicitação POST para o seguinte endpoint:
https://YOUR_CCAAS_HOST/apps/api/v1/calls/CALL_ID/dial
Substitua CALL_ID pelo ID da chamada.
Corpo da solicitação
Veja a seguir um exemplo de corpo de solicitação:
{
"agent_email": "AGENT_EMAIL",
"phone_number": "PHONE_NUMBER"
}
Substitua:
AGENT_EMAIL: o endereço de e-mail do agente na ligação.PHONE_NUMBER: o número de telefone do terceiro a ser adicionado à chamada.
Resposta
A resposta será semelhante a esta:
Resposta de sucesso
{
"message": "Third party dialing initiated",
"participant": {
"id": 54321,
"type": "third_party",
"status": "connecting"
}
}
Respostas de erro
400 Bad Request:phone_numberouagent_emailestá ausente ou vazio. Corpo:{"message": "param is missing or the value is empty: <name>"}.400 Bad Request:agent_emailnão corresponde a um usuário conhecido. Corpo:{"message": "Invalid agent_email"}.401 Unauthorized: falha na autenticação. Corpo:{"message": "Not Authorized"}.404 Not Found: não há chamada com ocall_idfornecido. Corpo:{"message": "Not Found"}.422 Unprocessable Entity: o agente identificado poragent_emailnão está conectado à chamada. Corpo:{"message": "Agent is not connected to the call"}.422 Unprocessable Entity: não foi possível iniciar a discagem. Abrange falhas de normalização de número de telefone e erros de início de discagem do provedor. Corpo:{"message": "Error dialing third party"}.500 Internal Server Error: falha inesperada durante a discagem. Corpo:{"message": "Unexpected error dialing third party"}.