音声方向の切替

ユーザーコールの発信APIで生成した通話中のユーザーコールの、通話音声の方向を切り替えます。

音声方向の切替により、ユーザーコールの発信先の音声を、通話相手先 に聞かせずに「聴取するだけ」の状態としたり、 AIオペレータの停止APIと組み合わせて AIオペレータの動作を止め、通話相手先とユーザーコールの発信先との実質的な二者通話にすることもできます。

リクエスト

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

stringrequired

音声方向を切り替える、ユーザーコールのコールID
リクエスト・ヘッダ
x-commubo-tenantId

stringrequired

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

stringrequired

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

stringrequired

"application/json" を指定してください。
リクエスト・ボディ
音声方向の情報を指定します。
{
    "mediaFlow": "sendonly"
}
mediaFlow

stringrequired

ユーザーコールの発信先との通話音声の方向を次の値により指定します。
sendrecv
ユーザーコールの発信先からの音声は通話相手先に聞こえ、AIオペレータと通話相手先の音声もユーザーコールの発信先に聞こえます。
AIオペレータの停止APIで、AIオペレータの動作を停止していない場合には、 ユーザーコールの発信先が発話した音声に対しても AIオペレータが認識して発話してしまうことに注意してください。
sendonly
ユーザーコールの発信先からの音声は通話相手先に聞こえませんが、AIオペレータと通話相手先の音声はユーザーコールの発信先に聞こえます。
recvonly
ユーザーコールの発信先からの音声は通話相手先に聞こえますが、AIオペレータと通話相手先の音声はユーザーコールの発信先に聞こえません。
AIオペレータの停止APIで、AIオペレータの動作を停止していない場合には、 ユーザーコールの発信先が発話した音声に対しても AIオペレータが認識して発話してしまうことに注意してください。
inactive
ユーザーコールの発信先からの音声は通話相手先に聞こえず、AIオペレータと通話相手先の音声もユーザーコールの発信先に聞こえません。
curl コマンドにおける例
音声方向の切替
curl -X POST \
  "https://connect.commubo.com:65536/v1/calls/1234567890123456/mediaflow" \
  -H "x-commubo-tenantId: 12345678-90AB-CDEF-1234-567890ABCDEF" \
  -H "x-commubo-accessToken: FEDCBA09-8765-4321-FEDC-BA0987654321" \
  -H "Content-type: application/json" \
  -d \
'
{
  "mediaFlow": "sendonly"
}
'

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

レスポンス

200 OK
リクエストが成功したことを示し、ユーザーコールの情報をレスポンス・ボディで返します。
レスポンス・ヘッダ
Content-type
application/json
レスポンス・ボディ
ユーザーコールのオブジェクトが返ります。
{
    "callId": "1234567890123456",
    "callType": "2",
    "phoneNumber": "0330001234"
}
callId

string

ユーザーコールのコールID。
callType

integer

通話の種別は、2 が示されます。
0
着信コール (commubo への着信)。
1
発信コール (commubo からの発信)。
2
ユーザーコール (ユーザーコールの発信API操作で commubo から発信)。
phoneNumber

string

ユーザーコールの発信先の電話番号。

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

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

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