Aggiungere una terza persona a una chiamata

Questo documento spiega come utilizzare l'endpoint /calls/CALL_ID/dial dell'API Apps per comporre il numero di una terza parte e aggiungerla a una chiamata in corso. Quando effettui una richiesta a questo endpoint, il sistema compone automaticamente il numero di telefono della terza parte e l'adattatore per chiamate dell'agente mostra la schermata Chiamata. L'aggiunta di terze parti alle chiamate in questo modo funziona indipendentemente dal fatto che l'adattatore per chiamate sia in esecuzione nel desktop dell'agente, nel CRM o nel portale della piattaforma CCAI. Perché questo endpoint funzioni, un agente deve essere impegnato in una chiamata attiva.

Chiama l'endpoint

Per aggiungere una terza parte a una chiamata, invia una richiesta POST al seguente endpoint:

https://YOUR_CCAAS_HOST/apps/api/v1/calls/CALL_ID/dial

Sostituisci CALL_ID con l'ID chiamata.

Corpo della richiesta

Di seguito è riportato un esempio di corpo della richiesta:

{
  "agent_email": "AGENT_EMAIL",
  "phone_number": "PHONE_NUMBER"
}

Sostituisci quanto segue:

  • AGENT_EMAIL: l'indirizzo email dell'agente durante la chiamata.
  • PHONE_NUMBER: il numero di telefono della terza parte da aggiungere alla chiamata.

Risposta

L'output è simile al seguente.

Risposta di esito positivo

{
    "message": "Third party dialing initiated",
    "participant": {
        "id": 54321,
        "type": "third_party",
        "status": "connecting"
    }
}

Risposte di errore

  • 400 Bad Request - phone_number o agent_email mancante o vuoto. Corpo: {"message": "param is missing or the value is empty: <name>"}.
  • 400 Bad Request: agent_email non corrisponde a un utente noto. Corpo: {"message": "Invalid agent_email"}.
  • 401 Unauthorized - autenticazione non riuscita. Corpo: {"message": "Not Authorized"}.
  • 404 Not Found: non esiste alcuna chiamata con il call_id fornito. Corpo: {"message": "Not Found"}.
  • 422 Unprocessable Entity: l'agente identificato da agent_email non è connesso alla chiamata. Corpo: {"message": "Agent is not connected to the call"}.
  • 422 Unprocessable Entity: non è stato possibile avviare la chiamata; copre gli errori di normalizzazione del numero di telefono e gli errori di avvio della chiamata del provider. Corpo: {"message": "Error dialing third party"}.
  • 500 Internal Server Error - errore imprevisto durante la composizione. Corpo: {"message": "Unexpected error dialing third party"}.