通話の転送

通話相手先との通話を、ユーザーコールの発信APIで生成したユーザーコールへ通話転送する処理を開始します。

通話の転送は、ユーザーによる電話応答など一連の操作が必要な機能であり、転送の結果を直ちに受け取ることができないため、通話の転送APIでは転送処理を開始すると、実際の転送の成功に関わらず直ちに処理を返します。実際の転送処理の結果は、通話状態の通知コールバックで、それぞれの通話が通話切断したことで判断できます。

通話転送が成功すると、通話相手先とユーザーコールの発信先は二者間での直接通話となり、それぞれの通話は commubo からは通話切断されます。

通話転送が成功すると、通話相手先とユーザーコールの発信先との通話は、commubo システムから切り離されます。このため、転送後は commubo による通話録音は行われないことに注意してください。

転送機能は、ご契約事業者さまでご利用の電話システムによっては、ご利用いただけない場合があります。詳しくは弊社担当者にお問い合わせください。

リクエスト

POST <ベースURL>/v1/calls/{callId}/transfer

パス・パラメータ

callId

stringrequired

転送する通話のコールID

リクエスト・ヘッダ

x-commubo-tenantId

stringrequired

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

x-commubo-accessToken

stringrequired

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

Content-type

stringrequired

"application/json" を指定してください。

リクエスト・ボディ

通話の転送先の情報を指定します。

{
"targetCallId": "9876543210987654"
}

targetCallId

stringrequired

転送先の通話のコールID を指定します。
転送先の通話には、ユーザーコールの発信APIで生成されたユーザーコールなど、転送対象の通話から生成 (派生) された通話中のコールのみ指定できます。

curl コマンドにおける例

通話の転送

curl -X POST \
  "https://connect.commubo.com:65536/v1/calls/1234567890123456/transfer" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321" \
  -H "Content-type: application/json" \
  -d \
'
{
  "targetCallId": "9876543210987654"
}
'

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

レスポンス

200 OK

リクエストが成功し、転送処理が開始されたたことを示します。
レスポンス・ボディは返しません。

403 Forbidden

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

404 Not Found

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

406 Not Acceptable

リクエストの内容が不足していたり、不整合な情報が含まれている、または指定された転送先のコールID の通話がユーザーコールでなかったり通話状態でないことを示します。
JSON 形式のレスポンス・ボディに、エラーの原因を示す場合があります。