Call Connection - Add Participant

リファレンス

サービス:: Communication

API バージョン:: 2024-09-15

通話に参加者を追加します。

POST {endpoint}/calling/callConnections/{callConnectionId}/participants:add?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.

要求本文

名前	必須	型	説明
participantToAdd	True	CommunicationIdentifierModel
customCallingContext		CustomCallingContext	カスタム呼び出しコンテキストをターゲットに送信するために顧客が使用する
invitationTimeoutInSeconds		integer	招待された参加者が受け取るのを待機するタイムアウトを取得または設定します。この最大値は 180 秒です
operationCallbackUri		string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。このセットアップはアクションごとに行われます。これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext		string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
sourceCallerIdNumber		PhoneNumberIdentifierModel
sourceDisplayName		string	(省略可能)PSTN 参加者またはチームユーザーを追加するときに、この招待操作に関連付けられているソースの表示名。注: 名簿の表示名は更新されません。

応答

名前	型	説明
202 Accepted	AddParticipantResponse	サービスは参加要素の追加要求を受け入れ、処理を開始します。要求の状態を更新するために、指定したコールバック URI で AddParticipantSucceeded または AddParticipantFailed イベントを受け取ります。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

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

型: apiKey
/: header

例

CallConnection_AddParticipant

要求のサンプル

HTTP

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

{
  "participantToAdd": {
    "kind": "communicationUser",
    "communicationUser": {
      "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
    }
  },
  "operationContext": "adding participant",
  "sourceCallerIdNumber": {
    "value": "+18440123456"
  },
  "operationCallbackUri": "https://app.contoso.com/callback"
}

応答のサンプル

状態コード:: 202

{
  "operationContext": "adding participant",
  "participant": {
    "identifier": {
      "kind": "communicationUser",
      "communicationUser": {
        "id": "8:acs:b9614373-fd0b-480c-8fd2-cb58b70eab9f_ae9e3307-f56e-44be-8934-80a63f080538"
      }
    },
    "isMuted": false
  },
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40"
}

定義

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

AddParticipantRequest

通話に参加者を追加するための要求ペイロード。

名前	型	説明
customCallingContext	CustomCallingContext	カスタム呼び出しコンテキストをターゲットに送信するために顧客が使用する
invitationTimeoutInSeconds	integer	招待された参加者が受け取るのを待機するタイムアウトを取得または設定します。この最大値は 180 秒です
operationCallbackUri	string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。このセットアップはアクションごとに行われます。これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext	string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。
participantToAdd	CommunicationIdentifierModel
sourceCallerIdNumber	PhoneNumberIdentifierModel
sourceDisplayName	string	(省略可能)PSTN 参加者またはチームユーザーを追加するときに、この招待操作に関連付けられているソースの表示名。注: 名簿の表示名は更新されません。

AddParticipantResponse

通話に参加者を追加するための応答ペイロード。

名前	型	説明
invitationId	string	参加者の追加に使用される招待 ID。
operationContext	string	クライアントによって提供される操作コンテキスト。
participant	CallParticipant	通話中の現在の参加者の一覧。

CallParticipant

通話参加者。

名前	型	説明
identifier	CommunicationIdentifierModel
isMuted	boolean	参加者がミュートされている
isOnHold	boolean	参加者が保留になっています。

CustomCallingContext

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

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

次の方法で共有

Call Connection - Add Participant

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Authorization

例

CallConnection_AddParticipant

要求のサンプル

応答のサンプル

定義

AddParticipantRequest

AddParticipantResponse

CallParticipant

CustomCallingContext

その他のリソース