Call Connection - Cancel Add Participant

サービス:

Communication

API バージョン:

2024-09-15

参加者の追加操作を取り消します。

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

要求本文

名前	必須	型	説明
invitationId	True	string	参加者の追加に使用される招待 ID。
operationCallbackUri		string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext		string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。

応答

名前	型	説明
202 Accepted	CancelAddParticipantResponse	cancelAddParticipant 応答を返します。
Other Status Codes	CommunicationErrorResponse	エラー

セキュリティ

Authorization

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

型: apiKey
/: header

例

CallConnection_CancelAddParticipant

要求のサンプル

HTTP

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

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant",
  "operationCallbackUri": "https://app.contoso.com/callback"
}

応答のサンプル

状態コード:

202

{
  "invitationId": "7b4244f8-d2ff-46d1-a629-4f9fb5f73d40",
  "operationContext": "cancelling add participant"
}

定義

名前	説明
CancelAddParticipantRequest	参加要素の追加要求を取り消す要求ペイロード。
CancelAddParticipantResponse	参加要素の追加要求をキャンセルするための応答ペイロード。

CancelAddParticipantRequest

参加要素の追加要求を取り消す要求ペイロード。

名前	型	説明
invitationId	string	参加者の追加に使用される招待 ID。
operationCallbackUri	string	この操作の CreateCall/AnswerCall によって設定された既定のコールバック URI をオーバーライドするコールバック URI を設定します。 このセットアップはアクションごとに行われます。 これが設定されていない場合は、CreateCall/AnswerCall によって設定された既定のコールバック URI が使用されます。
operationContext	string	応答イベントに要求を関連付けるために通話中のアクションを呼び出すときに顧客が使用します。

CancelAddParticipantResponse

参加要素の追加要求をキャンセルするための応答ペイロード。

名前	型	説明
invitationId	string	参加者の追加アクションを取り消すために使用される招待 ID。
operationContext	string	クライアントによって提供される操作コンテキスト。