ParticipantsCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-participants-collection-schema.json",
  "title": "ParticipantsCollection",
  "description": "A collection of participants in a room.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-azure-communication-services-rooms-api-openapi.yml#/components/schemas/ParticipantsCollection",
  "required": [
    "value"
  ],
  "type": "object",
  "properties": {
    "value": {
      "description": "A collection of participants.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/RoomParticipant"
      }
    },
    "nextLink": {
      "description": "If there are more participants that can be retrieved, the next link will be populated.",
      "type": "string"
    }
  },
  "$defs": {
    "Role": {
      "description": "The role of a room participant. The default value is Attendee.",
      "enum": [
        "Presenter",
        "Attendee",
        "Consumer",
        "Collaborator"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "Role",
        "modelAsString": true
      }
    },
    "RoomParticipant": {
      "description": "A participant of the room.",
      "required": [
        "rawId",
        "role"
      ],
      "type": "object",
      "properties": {
        "rawId": {
          "description": "Raw ID representation of the communication identifier. Please refer to the following document for additional information on Raw ID. <br> https://learn.microsoft.com/azure/communication-services/concepts/identifiers?pivots=programming-language-rest#raw-id-representation",
          "type": "string"
        },
        "role": {
          "$ref": "#/$defs/Role"
        }
      }
    }
  }
}