Participants - Update

サービス:

Communication

API バージョン:

2024-04-15

会議室の参加者を更新します。

PATCH {endpoint}/rooms/{roomId}/participants?api-version=2024-04-15

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string url	Azure Communication リソースのエンドポイント。
roomId	path	True	string	参加者を更新するルームの ID。
api-version	query	True	string	呼び出す API のバージョン。

要求ヘッダー

Media Types: "application/merge-patch+json"

名前	必須	型	説明
Authorization	True	string	HMAC-SHA256 スキームを使用して生成された署名を含む認証文字列。

要求本文

Media Types: "application/merge-patch+json"

名前	型	説明
participants	<string,  ParticipantProperties>	更新する参加者。

応答

名前	型	説明
200 OK	object	参加者は正常に更新されました。
Other Status Codes	CommunicationErrorResponse	エラー応答 ヘッダー x-ms-error-code: string

セキュリティ

Authorization

HMAC-SHA256 スキームを使用して生成された署名を含む認証文字列。

型: apiKey
/: header

例

Update participants

要求のサンプル

HTTP

PATCH https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2024-04-15

{
  "participants": {
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666": {
      "role": "Attendee"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777": {
      "role": "Presenter"
    },
    "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000888": null
  }
}

応答のサンプル

状態コード:

200

{}

定義

名前	説明
ParticipantProperties
Role	ルーム参加者の役割。 既定値は Attendee です。
UpdateParticipantsRequest	ルームで更新する参加者。

ParticipantProperties

名前	型	説明
role	Role	ルーム参加者の役割。 既定値は Attendee です。

Role

ルーム参加者の役割。 既定値は Attendee です。

名前	型	説明
Attendee	string
Consumer	string
Presenter	string

UpdateParticipantsRequest

ルームで更新する参加者。

名前	型	説明
participants	<string,  ParticipantProperties>	更新する参加者。