Microsoft Azure Communication Services Threads API

openapi: 3.2.0
info:
  title: Azure Communication Chat Service Threads API
  description: Azure Communication Chat Service
  version: '2025-03-15'
security:
- Authorization: []
tags:
- name: Threads
paths:
  /chat/threads/{chatThreadId}/readReceipts:
    get:
      tags:
      - Threads
      summary: Gets chat message read receipts for a thread
      operationId: ChatThread_ListChatReadReceipts
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to get the chat message read receipts for.
        required: true
        schema:
          type: string
      - in: query
        name: maxPageSize
        description: The maximum number of chat message read receipts to be returned per page.
        schema:
          type: integer
          format: int32
      - in: query
        name: skip
        description: Skips chat message read receipts 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 requested `ChatMessageReadReceipt` resources.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessageReadReceiptsCollection'
        '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
    post:
      tags:
      - Threads
      summary: Sends a read receipt event to a thread, on behalf of a user
      operationId: ChatThread_SendChatReadReceipt
      parameters:
      - in: path
        name: chatThreadId
        description: Thread id to send the read receipt event to.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          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/SendReadReceiptRequest'
        description: Read receipt details.
        required: true
  /chat/threads:
    post:
      tags:
      - Threads
      summary: Creates a chat thread
      operationId: Chat_CreateChatThread
      parameters:
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Thread created, the `Location` header would contain the URL for the newly created thread.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChatThreadResult'
        '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/CreateChatThreadRequest'
        description: Request payload for creating a chat thread.
        required: true
    get:
      tags:
      - Threads
      summary: Gets the list of chat threads of a user
      operationId: Chat_ListChatThreads
      parameters:
      - in: query
        name: maxPageSize
        description: The maximum number of chat threads returned per page.
        schema:
          type: integer
          format: int32
      - in: query
        name: startTime
        description: 'The earliest point in time to get chat threads up to. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        schema:
          type: string
          format: date-time
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a `GetThreadsResponse` resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatThreadsItemCollection'
        '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}:
    patch:
      tags:
      - Threads
      summary: Updates a thread's properties
      operationId: ChatThread_UpdateChatThreadProperties
      parameters:
      - in: path
        name: chatThreadId
        description: The id of the thread to update.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Thread was successfully updated.
        '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/merge-patch+json:
            schema:
              $ref: '#/components/schemas/UpdateChatThreadRequest'
        description: Request payload for updating a chat thread.
        required: true
    get:
      tags:
      - Threads
      summary: Gets a chat thread's properties
      operationId: ChatThread_GetChatThreadProperties
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a chat thread.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatThreadProperties'
        '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'
    delete:
      tags:
      - Threads
      summary: Deletes a thread
      operationId: Chat_DeleteChatThread
      parameters:
      - in: path
        name: chatThreadId
        description: Id of the thread to be deleted.
        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'
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.
    ChatThreadItem:
      description: Summary information of a chat thread.
      required:
      - id
      - topic
      type: object
      properties:
        id:
          description: Chat thread id.
          type: string
          example: 19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2
        topic:
          description: Chat thread topic.
          type: string
          example: Lunch Chat thread
        deletedOn:
          format: date-time
          description: 'The timestamp when the chat thread was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          example: '2020-10-30T10:50:50Z'
        lastMessageReceivedOn:
          format: date-time
          description: 'The timestamp when the last message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          readOnly: true
          example: '2020-10-30T10:50:50Z'
    ChatThreadsItemCollection:
      description: Collection of chat threads.
      required:
      - value
      type: object
      properties:
        value:
          description: Collection of chat threads.
          type: array
          items:
            $ref: '#/components/schemas/ChatThreadItem'
        nextLink:
          description: If there are more chat threads that can be retrieved, the next link will be populated.
          type: string
          readOnly: true
    ChatRetentionPolicy:
      description: Data retention policy for auto deletion.
      type: object
      discriminator:
        propertyName: kind
      properties:
        kind:
          description: Retention Policy Type
          enum:
          - threadCreationDate
          - none
          type: string
          x-ms-enum:
            name: RetentionPolicyKind
            modelAsString: true
            values:
            - value: threadCreationDate
              description: Thread retention policy based on thread creation date.
            - value: none
              description: No thread retention policy
      required:
      - kind
    SendReadReceiptRequest:
      description: Request payload for sending a read receipt.
      required:
      - chatMessageId
      type: object
      properties:
        chatMessageId:
          description: Id of the latest chat message read by the user.
          type: string
          example: '1592435762364'
    CommonCommunicationErrorResponse:
      description: The Communication Services error.
      type: object
      required:
      - error
      properties:
        error:
          description: The Communication Services error.
          $ref: '#/components/schemas/CommunicationError'
    CommunicationError:
      $ref: '#/components/schemas/CommonCommunicationError'
    ChatThreadProperties:
      description: Chat thread.
      required:
      - createdByCommunicationIdentifier
      - createdOn
      - id
      - topic
      type: object
      properties:
        id:
          description: Chat thread id.
          type: string
          example: 19:uni01_uy5ucb66ugp3lrhe7pxso6xx4hsmm3dl6eyjfefv2n6x3rrurpea@thread.v2
        topic:
          description: Chat thread topic.
          type: string
          example: Lunch Chat thread
        createdOn:
          format: date-time
          description: 'The timestamp when the chat thread was created. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          example: '2020-10-30T10:50:50Z'
        createdByCommunicationIdentifier:
          $ref: '#/components/schemas/CommunicationIdentifierModel'
        deletedOn:
          format: date-time
          description: 'The timestamp when the chat thread was deleted. 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 thread. 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
        retentionPolicy:
          $ref: '#/components/schemas/ChatRetentionPolicy'
    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.
    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.
    CommunicationCloudEnvironmentModel:
      description: The cloud that the identifier belongs to.
      type: string
      enum:
      - public
      - dod
      - gcch
      x-ms-enum:
        name: CommunicationCloudEnvironmentModel
        modelAsString: true
    CreateChatThreadRequest:
      description: Request payload for creating a chat thread.
      required:
      - topic
      type: object
      properties:
        topic:
          description: The chat thread topic.
          type: string
          example: Lunch Thread
        participants:
          description: Participants to be added to the chat thread.
          type: array
          items:
            $ref: '#/components/schemas/ChatParticipant'
        metadata:
          description: Contextual metadata for the thread. 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
        retentionPolicy:
          $ref: '#/components/schemas/ChatRetentionPolicy'
    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
    CommunicationIdentifierModel:
      $ref: '#/components/schemas/CommonCommunicationIdentifierModel'
    UpdateChatThreadRequest:
      description: Request payload for updating a chat thread.
      type: object
      properties:
        topic:
          description: Chat thread topic.
          type: string
          example: Lunch Thread
        metadata:
          description: Contextual metadata for the thread. 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
        retentionPolicy:
          $ref: '#/components/schemas/ChatRetentionPolicy'
    CommunicationErrorResponse:
      $ref: '#/components/schemas/CommonCommunicationErrorResponse'
    ChatMessageReadReceiptsCollection:
      description: A paged collection of chat message read receipts.
      required:
      - value
      type: object
      properties:
        value:
          description: Collection of chat message read receipts.
          type: array
          items:
            $ref: '#/components/schemas/ChatMessageReadReceipt'
        nextLink:
          description: If there are more chat message read receipts that can be retrieved, the next link will be populated.
          type: string
          readOnly: true
    MicrosoftTeamsUserIdentifierModel:
      $ref: '#/components/schemas/CommonMicrosoftTeamsUserIdentifierModel'
    MicrosoftTeamsAppIdentifierModel:
      $ref: '#/components/schemas/CommonMicrosoftTeamsAppIdentifierModel'
    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.
    ChatMessageReadReceipt:
      description: A chat message read receipt indicates the time a chat message was read by a recipient.
      required:
      - chatMessageId
      - readOn
      - senderCommunicationIdentifier
      type: object
      properties:
        senderCommunicationIdentifier:
          $ref: '#/components/schemas/CommunicationIdentifierModel'
        chatMessageId:
          description: Id of the chat message that has been read. This id is generated by the server.
          type: string
          example: '1591137790240'
        readOn:
          format: date-time
          description: 'The time at which the message was read. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
          type: string
          example: '2020-10-30T10:50:50Z'
    CreateChatThreadResult:
      description: Result of the create chat thread operation.
      type: object
      properties:
        chatThread:
          $ref: '#/components/schemas/ChatThreadProperties'
        invalidParticipants:
          description: The participants that failed to be added to the chat thread.
          type: array
          items:
            $ref: '#/components/schemas/CommunicationError'
          readOnly: true
    CommunicationUserIdentifierModel:
      $ref: '#/components/schemas/CommonCommunicationUserIdentifierModel'
  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'