Microsoft Azure Communication Services Participants API

openapi: 3.2.0
info:
  title: Azure Communication Chat Service Participants API
  description: Azure Communication Chat Service
  version: '2025-03-15'
security:
- Authorization: []
tags:
- name: Participants
paths:
  /chat/threads/{chatThreadId}/participants:
    get:
      tags:
      - Participants
      summary: Gets the participants of a thread
      operationId: ChatThread_ListChatParticipants
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to get participants for.
        required: true
        schema:
          type: string
      - in: query
        name: maxPageSize
        description: The maximum number of participants to be returned per page.
        schema:
          type: integer
          format: int32
      - in: query
        name: skip
        description: Skips participants up to a specified position in response.
        schema:
          type: integer
          format: int32
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns the participants of a thread.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatParticipantsCollection'
        '401':
          description: Unauthorized.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '403':
          description: Forbidden.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '429':
          description: Too many requests.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '503':
          description: Service unavailable.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
  /chat/threads/{chatThreadId}/participants/:remove:
    post:
      tags:
      - Participants
      summary: Remove a participant from a thread
      operationId: ChatThread_RemoveChatParticipant
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to remove the participant from.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Request successful.
        '401':
          description: Unauthorized.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '403':
          description: Forbidden.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '429':
          description: Too many requests.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '503':
          description: Service unavailable.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunicationIdentifierModel'
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/CommunicationIdentifierModel'
        description: Id of the thread participant to remove from the thread.
        required: true
  /chat/threads/{chatThreadId}/participants/:add:
    post:
      tags:
      - Participants
      summary: Adds thread participants to a thread.
      operationId: ChatThread_AddChatParticipants
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread to add participants to.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: The participants were successfully added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddChatParticipantsResult'
        '401':
          description: Unauthorized.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '403':
          description: Forbidden.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '429':
          description: Too many requests.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
        '503':
          description: Service unavailable.
          x-ms-error-response: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddChatParticipantsRequest'
        description: Thread participants to be added to the thread.
        required: true
  /rooms/{roomId}/participants:
    get:
      tags:
      - Participants
      summary: Get participants in a room
      operationId: Participants_List
      parameters:
      - in: path
        name: roomId
        description: The id of the room to get participants from.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns the participants of the room.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantsCollection'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
    patch:
      tags:
      - Participants
      summary: Update participants in a room
      operationId: Participants_Update
      parameters:
      - in: path
        name: roomId
        description: The id of the room to update the participants in.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The participants were successfully updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateParticipantsResult'
        default:
          description: Error response
          headers:
            x-ms-error-code:
              x-ms-client-name: ErrorCode
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationErrorResponse'
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateParticipantsRequest'
        description: An updated set of participants of the room.
        required: true
components:
  schemas:
    CommonMicrosoftTeamsAppIdentifierModel:
      description: A Microsoft Teams application.
      type: object
      required:
      - appId
      properties:
        appId:
          type: string
          description: The Id of the Microsoft Teams application.
        cloud:
          $ref: '#/components/schemas/CommunicationCloudEnvironmentModel'
          description: The cloud that the Microsoft Teams application belongs to. By default 'public' if missing.
    CommonCommunicationIdentifierModel:
      description: 'Identifies a participant in Azure Communication services. A participant is, for example, a phone number or an Azure communication user. This model is polymorphic: Apart from kind and rawId, at most one further property may be set which must match the kind enum value.'
      type: object
      properties:
        kind:
          $ref: '#/components/schemas/CommunicationIdentifierModelKind'
          description: The identifier kind. Only required in responses.
        rawId:
          type: string
          description: Raw Id of the identifier. Optional in requests, required in responses.
        communicationUser:
          $ref: '#/components/schemas/CommunicationUserIdentifierModel'
          description: The communication user.
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumberIdentifierModel'
          description: The phone number.
        microsoftTeamsUser:
          $ref: '#/components/schemas/MicrosoftTeamsUserIdentifierModel'
          description: The Microsoft Teams user.
        microsoftTeamsApp:
          $ref: '#/components/schemas/MicrosoftTeamsAppIdentifierModel'
          description: The Microsoft Teams application.
        teamsExtensionUser:
          $ref: '#/components/schemas/TeamsExtensionUserIdentifierModel'
          description: The Microsoft Teams Extension user.
    CommonCommunicationError:
      description: The Communication Services error.
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: The error code.
        message:
          type: string
          description: The error message.
        target:
          type: string
          readOnly: true
          description: The error target.
        details:
          type: array
          items:
            $ref: '#/components/schemas/CommunicationError'
          readOnly: true
          description: Further details about specific errors that led to this error.
        innererror:
          x-ms-client-name: innerError
          readOnly: true
          $ref: '#/components/schemas/CommunicationError'
          description: The inner error if any.
    ChatParticipant:
      description: A participant of the chat thread.
      required:
      - communicationIdentifier
      type: object
      properties:
        communicationIdentifier:
          $ref: '#/components/schemas/CommunicationIdentifierModel'
        displayName:
          description: Display name for the chat participant.
          type: string
          example: Bob
        shareHistoryTime:
          format: date-time
          description: 'Time from which the chat history is shared with the participant. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          example: '2020-10-30T10:50:50Z'
        metadata:
          description: Contextual metadata for the chat participant. The metadata consists of name/value pairs. The total size of all metadata pairs can be up to 1KB in size.
          type: object
          additionalProperties:
            type: string
    CommonCommunicationUserIdentifierModel:
      description: A user that got created with an Azure Communication Services resource.
      type: object
      required:
      - id
      properties:
        id:
          type: string
          description: The Id of the communication user.
    CommonMicrosoftTeamsUserIdentifierModel:
      description: A Microsoft Teams user.
      type: object
      required:
      - userId
      properties:
        userId:
          type: string
          description: The Id of the Microsoft Teams user. If not anonymous, this is the Entra ID object Id of the user.
        isAnonymous:
          type: boolean
          description: True if the Microsoft Teams user is anonymous. By default false if missing.
        cloud:
          $ref: '#/components/schemas/CommunicationCloudEnvironmentModel'
          description: The cloud that the Microsoft Teams user belongs to. By default 'public' if missing.
    CommunicationIdentifierModel:
      $ref: '#/components/schemas/CommonCommunicationIdentifierModel'
    CommunicationCloudEnvironmentModel:
      description: The cloud that the identifier belongs to.
      type: string
      enum:
      - public
      - dod
      - gcch
      x-ms-enum:
        name: CommunicationCloudEnvironmentModel
        modelAsString: true
    CommunicationErrorResponse:
      $ref: '#/components/schemas/CommonCommunicationErrorResponse'
    CommunicationUserIdentifierModel:
      $ref: '#/components/schemas/CommonCommunicationUserIdentifierModel'
    MicrosoftTeamsUserIdentifierModel:
      $ref: '#/components/schemas/CommonMicrosoftTeamsUserIdentifierModel'
    ChatParticipantsCollection:
      description: Collection of participants belong to a particular thread.
      required:
      - value
      type: object
      properties:
        value:
          description: Chat participants.
          type: array
          items:
            $ref: '#/components/schemas/ChatParticipant'
        nextLink:
          description: If there are more chat participants that can be retrieved, the next link will be populated.
          type: string
          readOnly: true
    AddChatParticipantsRequest:
      description: Participants to be added to the thread.
      required:
      - participants
      type: object
      properties:
        participants:
          description: Participants to add to a chat thread.
          type: array
          items:
            $ref: '#/components/schemas/ChatParticipant'
    MicrosoftTeamsAppIdentifierModel:
      $ref: '#/components/schemas/CommonMicrosoftTeamsAppIdentifierModel'
    CommonCommunicationErrorResponse:
      description: The Communication Services error.
      type: object
      required:
      - error
      properties:
        error:
          description: The Communication Services error.
          $ref: '#/components/schemas/CommunicationError'
    AddChatParticipantsResult:
      description: Result of the add chat participants operation.
      type: object
      properties:
        invalidParticipants:
          description: The participants that failed to be added to the chat thread.
          type: array
          items:
            $ref: '#/components/schemas/CommunicationError'
          readOnly: true
    CommunicationError:
      $ref: '#/components/schemas/CommonCommunicationError'
    UpdateParticipantsResult:
      description: Request response for updating participants.
      type: object
    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
    ParticipantProperties:
      required:
      - role
      type: object
      properties:
        role:
          $ref: '#/components/schemas/Role'
    ParticipantsCollection:
      description: A collection of participants in a room.
      required:
      - value
      type: object
      properties:
        value:
          description: A collection of participants.
          type: array
          items:
            $ref: '#/components/schemas/RoomParticipant'
        nextLink:
          description: If there are more participants that can be retrieved, the next link will be populated.
          type: string
    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: '#/components/schemas/Role'
    UpdateParticipantsRequest:
      description: Participants to be updated in the room.
      type: object
      properties:
        participants:
          description: Participants to be updated.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ParticipantProperties'
          example:
            rawId1:
              role: Presenter
            rawId2:
              role: Attendee
            rawId3:
              role: Collaborator
            rawId4: null
  parameters:
    ApiVersionParameter:
      in: query
      name: api-version
      description: Version of API to invoke.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    Authorization:
      type: apiKey
      name: Authorization
      in: header
      description: An ACS (Azure Communication Services) user access token.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'