Ajouter un tiers à un appel

Ce document explique comment utiliser le point de terminaison /calls/CALL_ID/dial de l'API Apps pour composer le numéro d'un tiers, puis l'ajouter à un appel en cours. Lorsque vous envoyez une requête à ce point de terminaison, le système compose automatiquement le numéro de téléphone du tiers, et l'adaptateur d'appel de l'agent affiche l'écran Appel. L'ajout de tiers aux appels de cette manière fonctionne, que l'adaptateur d'appel soit exécuté sur le bureau de l'agent, dans votre CRM ou sur le portail de la plate-forme CCAI. Un agent doit être en cours d'appel pour que ce point de terminaison fonctionne.

Appeler le point de terminaison

Pour ajouter un tiers à un appel, envoyez une requête POST au point de terminaison suivant :

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

Remplacez CALL_ID par l'ID de l'appel.

Corps de la requête

Voici un exemple de corps de requête :

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

Remplacez les éléments suivants :

• AGENT_EMAIL : adresse e-mail de l'agent participant à l'appel.
• PHONE_NUMBER : numéro de téléphone du tiers à ajouter à l'appel.

Réponse

Le résultat renvoyé ressemble à ceci :

Réponse de réussite

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

Réponses d'erreur

• 400 Bad Request : phone_number ou agent_email est manquant ou vide. Corps : {"message": "param is missing or the value is empty: <name>"}.
• 400 Bad Request : agent_email ne correspond pas à un utilisateur connu. Corps : {"message": "Invalid agent_email"}.
• 401 Unauthorized : échec de l'authentification. Corps : {"message": "Not Authorized"}.
• 404 Not Found : aucun appel n'existe avec l'ID call_id fourni. Corps : {"message": "Not Found"}.
• 422 Unprocessable Entity : l'agent identifié par agent_email n'est pas connecté à l'appel. Corps : {"message": "Agent is not connected to the call"}.
• 422 Unprocessable Entity : l'appel n'a pas pu être lancé. Couvre les échecs de normalisation des numéros de téléphone et les erreurs de lancement d'appel du fournisseur. Corps : {"message": "Error dialing third party"}.
• 500 Internal Server Error : échec inattendu lors de la numérotation. Corps : {"message": "Unexpected error dialing third party"}.