通話に第三者を追加する

このドキュメントでは、Apps API の /calls/CALL_ID/dial エンドポイントを使用してサードパーティにダイヤルし、進行中の通話に追加する方法について説明します。このエンドポイントにリクエストを送信すると、システムはサードパーティの電話番号に自動的にダイヤルし、エージェントの通話アダプタに [Calling] 画面が表示されます。この方法でサードパーティを通話に追加すると、通話アダプタがエージェント デスクトップ、CRM、CCAI Platform ポータルのいずれで実行されているかに関係なく機能します。このエンドポイントが機能するには、エージェントがアクティブな通話中である必要があります。

エンドポイントを呼び出す

通話にサードパーティを追加するには、次のエンドポイントに POST リクエストを送信します。

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

CALL_ID は、コール ID に置き換えます。

リクエストの本文

リクエスト本文の例を次に示します。

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

次のように置き換えます。

  • AGENT_EMAIL: 通話中のエージェントのメールアドレス。
  • PHONE_NUMBER: 通話に追加するサードパーティの電話番号。

レスポンス

出力は次のようになります。

成功のレスポンス

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

Error responses（エラー応答）

  • 400 Bad Request - phone_number または agent_email がないか、空です。本文: {"message": "param is missing or the value is empty: <name>"}。
  • 400 Bad Request - agent_email が既知のユーザーと一致しません。本文: {"message": "Invalid agent_email"}。
  • 401 Unauthorized - 認証に失敗しました。本文: {"message": "Not Authorized"}。
  • 404 Not Found - 指定された call_id の通話が存在しません。本文: {"message": "Not Found"}。
  • 422 Unprocessable Entity - agent_email で識別されるエージェントが通話に接続されていません。本文: {"message": "Agent is not connected to the call"}。
  • 422 Unprocessable Entity - ダイヤルを開始できませんでした。電話番号の正規化エラーとプロバイダのダイヤル開始エラーが含まれます。本文: {"message": "Error dialing third party"}。
  • 500 Internal Server Error - ダイヤル中に予期しないエラーが発生しました。本文: {"message": "Unexpected error dialing third party"}。