通話の切断

指定した通話を切断します。

切断する通話には、すべての通話種別 (着信コール、発信コール、ユーザーコール) の通話中のコールを指定できます。
通常、AIオペレータ と 通話相手先 との通話は、会話シナリオ内の制御によって自動的に通話切断されます。 また、ユーザーコールの発信APIで生成したユーザーコールも、生成元の AIオペレータと通話相手先との通話が切断すると、 これに伴って自動的に切断されます。
通話の切断APIは、手動 (API呼出し) による強制的な通話切断となることに注意してください。

リクエスト

POST <ベースURL>/v1/calls/{callId}/disconnect
パス・パラメータ
callId

stringrequired

切断する対象のコールID
リクエスト・ヘッダ
x-commubo-tenantId

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のテナントID。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
x-commubo-accessToken

stringrequired

commubo契約時に発行される、ご契約事業者さま固有のアクセストークン。 「commubo connect ご契約ユーザーさま ダッシュボード・ページ」内の 「設定 / テナント」メニューから確認できます。
リクエスト・ボディ
リクエスト・ボディは必要ありません。
curl コマンドにおける例
通話の切断
curl -X POST \
  "https://connect.commubo.com:65536/v1/calls/1234567890123456/disconnect" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321"

※ 赤字部分はご契約事業者さまの環境に合わせ、適切なパラメータを指定してください。

レスポンス

200 OK
リクエストが成功し、通話が切断されたことを示します。
レスポンス・ボディは返しません。

403 Forbidden
テナントID または アクセストークン が正しくないなど、アクセスが許可されないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。

404 Not Found
リエクストのパス・パラメータで指定された コールID の 通話 が存在しない、または通話状態でないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。