Rooms - Remove Participants

Hizmet:

Communication

API Sürümü:

2022-02-01

Katılımcıları bir odadan kaldırın.

POST {endpoint}/rooms/{roomId}/participants:remove?api-version=2022-02-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Azure İletişim kaynağının uç noktası.
roomId	path	True	string	Katılımcıların kaldırılacağı oda kimliği.
api-version	query	True	string	Çağrılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Authorization	True	string	ACS (Azure İletişim Hizmetleri) kullanıcı erişim belirteci.

İstek Gövdesi

Name	Gerekli	Tür	Description
participants	True	RoomParticipant[]	Bir odadan kaldırılacak katılımcılar.

Yanıtlar

Name	Tür	Description
200 OK	ParticipantsCollection	Katılımcılar başarıyla silindi. Eylem, güncelleştirilmiş bir katılımcı listesi döndürür.
Other Status Codes	CommunicationErrorResponse	Hata yanıtı Üst Bilgiler x-ms-error-code: string

Güvenlik

Authorization

ACS (Azure İletişim Hizmetleri) kullanıcı erişim belirteci.

Tür: apiKey
İçinde: header

Örnekler

Remove participant

Örnek isteği

HTTP

POST https://contoso.communication.azure.com//rooms/99199690362660524/participants:remove?api-version=2022-02-01

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000666"
        }
      },
      "role": "Presenter"
    }
  ]
}

Örnek yanıt

Durum kodu:

200

{
  "participants": [
    {
      "communicationIdentifier": {
        "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777",
        "communicationUser": {
          "id": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000777"
        }
      },
      "role": "Attendee"
    }
  ]
}

Tanımlar

Name	Description
CommunicationIdentifierModel	Azure İletişim hizmetlerindeki bir katılımcıyı tanımlar. Katılımcı, örneğin bir Azure iletişim kullanıcısıdır. Bu modelin bir birleşim olarak yorumlanması gerekir: RawId dışında en fazla bir özellik daha ayarlanabilir.
ParticipantsCollection	Bir odadaki katılımcı koleksiyonu.
RemoveParticipantsRequest	Bir odadan kaldırılacak katılımcılar.
RoleType	Oda katılımcısının rolü.
RoomParticipant	Odanın bir katılımcısı.

CommunicationIdentifierModel

Object

Azure İletişim hizmetlerindeki bir katılımcıyı tanımlar. Katılımcı, örneğin bir Azure iletişim kullanıcısıdır. Bu modelin bir birleşim olarak yorumlanması gerekir: RawId dışında en fazla bir özellik daha ayarlanabilir.

Name	Tür	Description
communicationUser	CommunicationUserIdentifierModel
rawId	string	Tanımlayıcının ham kimliği. İsteklerde isteğe bağlı, yanıtlarda gereklidir.

ParticipantsCollection

Object

Bir odadaki katılımcı koleksiyonu.

Name	Tür	Description
participants	RoomParticipant[]	Oda Katılımcıları.

RemoveParticipantsRequest

Object

Bir odadan kaldırılacak katılımcılar.

Name	Tür	Description
participants	RoomParticipant[]	Bir odadan kaldırılacak katılımcılar.

RoleType

Listeleme

Oda katılımcısının rolü.

Değer	Description
Presenter
Attendee
Consumer

RoomParticipant

Object

Odanın bir katılımcısı.

Name	Tür	Description
communicationIdentifier	CommunicationIdentifierModel	Azure İletişim hizmetlerindeki bir katılımcıyı tanımlar. Katılımcı, örneğin bir Azure iletişim kullanıcısıdır. Bu modelin bir birleşim olarak yorumlanması gerekir: RawId dışında en fazla bir özellik daha ayarlanabilir.
role	RoleType	Oda katılımcısının rolü.