Call Connection - Transfer To Participant

サービス:

Communication

API バージョン:

2024-09-15

参加者に通話を転送します。

POST {endpoint}/calling/callConnections/{callConnectionId}:transferToParticipant?api-version=2024-09-15

URI パラメーター

名前	/	必須	型	説明
callConnectionId	path	True	string	呼び出し接続 ID。
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	Azure Communication Services ユーザー アクセス トークン。
Repeatability-Request-ID		string uuid	指定した場合、クライアントは要求が繰り返し可能であることを指示します。つまり、クライアントは同じ Repeatability -Request-Id で要求を複数回行い、サーバーが要求を複数回実行せずに適切な応答を返すことができます。 Repeatability-Request-Id の値は、クライアントによって生成された要求の一意識別子を表す不透明な文字列です。 これはバージョン 4 (ランダム) UUID です。
Repeatability-First-Sent		string date-time-rfc1123	Repeatability-Request-ID ヘッダーを指定する場合は、Repeatability-First-Sent ヘッダーも指定する必要があります。 値は、要求が最初に作成された日時で、HTTP 日付の IMF-fixdate 形式を使用して表されます。 例: Sun, 06 Nov 1994 08:49:37 GMT.

要求本文

名前	必須	型	説明
targetParticipant	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	カスタム呼び出しコンテキストをターゲットに送信するために顧客が使用する
operationCallbackUri		string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext		string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
sourceCallerIdNumber		PhoneNumberIdentifierModel
transferee		CommunicationIdentifierModel

応答

名前	型	説明
202 Accepted	TransferCallResponse	サービスは転送要求を受け入れ、処理を開始します。 指定したコールバック URI で CallTransferAccepted または CallTransferFailed イベントを受け取り、要求の状態を更新します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

Azure Communication Services ユーザー アクセス トークン。

型: apiKey
/: header

例

CallConnection_TransferToParticipant

要求のサンプル

HTTP

POST https://contoso.communications.azure.com/calling/callConnections/18dea47f-b081-4107-9a5c-4300819d2c6c:transferToParticipant?api-version=2024-09-15

{
  "targetParticipant": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_da7be3a9-8788-42a6-85c6-56b2cf784fce"
    }
  },
  "transferee": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationCallbackUri": "https://app.contoso.com/callback",
  "operationContext": "trasferring call"
}

応答のサンプル

状態コード:

202

{
  "operationContext": "trasferring call"
}

定義

名前	説明
CustomCallingContext	ターゲットに送信されるカスタム呼び出しコンテキスト
TransferCallResponse	呼び出しを転送するための応答ペイロード。
TransferToParticipantRequest	参加者に呼び出しを転送するための要求ペイロード。

CustomCallingContext

ターゲットに送信されるカスタム呼び出しコンテキスト

名前	型	説明
sipHeaders	object	カスタム呼び出しコンテキスト SIP ヘッダー
voipHeaders	object	カスタム呼び出しコンテキスト VoiP ヘッダー

TransferCallResponse

呼び出しを転送するための応答ペイロード。

名前	型	説明
operationContext	string	クライアントによって提供される操作コンテキスト。

TransferToParticipantRequest

参加者に呼び出しを転送するための要求ペイロード。

名前	型	説明
customCallingContext	CustomCallingContext	カスタム呼び出しコンテキストをターゲットに送信するために顧客が使用する
operationCallbackUri	string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext	string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
sourceCallerIdNumber	PhoneNumberIdentifierModel
targetParticipant	CommunicationIdentifierModel
transferee	CommunicationIdentifierModel