Aracılığıyla paylaş

Participants - List

  • Başvuru
Hizmet:
Communication
API Sürümü:
2023-10-30-preview

Katılımcıları bir odaya alın.

GET {endpoint}/rooms/{roomId}/participants?api-version=2023-10-30-preview

URI Parametreleri

Name İçinde Gerekli Tür Description
endpoint
 path True

string

url

Azure İletişim kaynağının uç noktası.
roomId
 path True

string

Katılımcıları almak için odanın 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

HMAC-SHA256 şeması kullanılarak oluşturulan imzayı içeren bir kimlik doğrulama dizesi.

Yanıtlar

Name Tür Description
200 OK

ParticipantsCollection

İstek başarılı. Eylem, odanın katılımcılarını döndürür.
Other Status Codes

CommunicationErrorResponse

Hata yanıtı

Üst Bilgiler

x-ms-error-code: string

Güvenlik

Authorization

HMAC-SHA256 şeması kullanılarak oluşturulan imzayı içeren bir kimlik doğrulama dizesi.

Tür: apiKey
İçinde: header

Örnekler

Get participants

Örnek isteği

GET https://contoso.communication.azure.com//rooms/99199690362660524/participants?api-version=2023-10-30-preview

Örnek yanıt

Durum kodu:
200 
{
  "value": [
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000333",
      "role": "Presenter"
    },
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000444",
      "role": "Attendee"
    },
    {
      "rawId": "8:acs:db75ed0c-e801-41a3-99a4-66a0a119a06c_00000010-ce28-064a-83fe-084822000555",
      "role": "Attendee"
    }
  ]
}

Tanımlar

Name Description
ParticipantsCollection

Bir odadaki katılımcı koleksiyonu.
Role

Oda katılımcısının rolü. Varsayılan değer Attendee'dir.
RoomParticipant

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

ParticipantsCollection

Bir odadaki katılımcı koleksiyonu.

Name Tür Description
nextLink

string

Alınabilecek daha fazla katılımcı varsa, sonraki bağlantı doldurulur.
value

RoomParticipant[]

Katılımcılardan oluşan bir koleksiyon.

Role

Oda katılımcısının rolü. Varsayılan değer Attendee'dir.

Name Tür Description
Attendee

string

Consumer

string

Presenter

string

RoomParticipant

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

Name Tür Description
rawId

string

İletişim tanımlayıcısının ham kimlik gösterimi. Ham Kimlik hakkında ek bilgi için lütfen aşağıdaki belgeye bakın.
https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation
role

Role

Oda katılımcısının rolü. Varsayılan değer Attendee'dir.