swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Messages API
schemes:
- https
tags:
- name: Messages
paths:
  /chat/threads/{chatThreadId}/messages:
    post:
      tags:
      - Messages
      summary: Microsoft Azure Sends A Message To A Thread
      operationId: microsoftAzureChatthreadSendchatmessage
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to send the message to.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: sendChatMessageRequest
        description: Details of the message to send.
        required: true
        schema:
          $ref: '#/definitions/SendChatMessageRequest'
      responses:
        '201':
          description: Message sent, the `Location` header contains the URL for the newly sent message.
          schema:
            $ref: '#/definitions/SendChatMessageResult'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Send Message:
          $ref: ./examples/Messages_SendChatMessage.json
      description: Needs a more full description created.
    get:
      tags:
      - Messages
      summary: Microsoft Azure Gets A List Of Messages From A Thread
      operationId: microsoftAzureChatthreadListchatmessages
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id of the message.
        required: true
        type: string
      - in: query
        name: maxPageSize
        description: The maximum number of messages to be returned per page.
        type: integer
        format: int32
      - in: query
        name: startTime
        description: 'The earliest point in time to get messages after. The timestamp should be in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        format: date-time
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ChatMessagesCollection'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get messages with pagination (max page size):
          $ref: ./examples/Messages_ListChatMessagesWithPageSize.json
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: value
      description: Needs a more full description created.
  /chat/threads/{chatThreadId}/messages/{chatMessageId}:
    get:
      tags:
      - Messages
      summary: Microsoft Azure Gets A Message By Id
      operationId: microsoftAzureChatthreadGetchatmessage
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to which the message was sent.
        required: true
        type: string
      - in: path
        name: chatMessageId
        description: The message id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Request successful. The action returns a `Message` resource.
          schema:
            $ref: '#/definitions/ChatMessage'
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Get Message:
          $ref: ./examples/Messages_GetChatMessage.json
      description: Needs a more full description created.
    patch:
      tags:
      - Messages
      summary: Microsoft Azure Updates A Message
      operationId: microsoftAzureChatthreadUpdatechatmessage
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to which the message was sent.
        required: true
        type: string
      - in: path
        name: chatMessageId
        description: The message id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: updateChatMessageRequest
        description: Details of the request to update the message.
        required: true
        schema:
          $ref: '#/definitions/UpdateChatMessageRequest'
      responses:
        '204':
          description: Message is successfully updated.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Update message content:
          $ref: ./examples/Messages_UpdateChatMessage.json
      description: Needs a more full description created.
    delete:
      tags:
      - Messages
      summary: Microsoft Azure Deletes A Message
      operationId: microsoftAzureChatthreadDeletechatmessage
      produces:
      - application/json
      parameters:
      - in: path
        name: chatThreadId
        description: The thread id to which the message was sent.
        required: true
        type: string
      - in: path
        name: chatMessageId
        description: The message id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '204':
          description: Request successful.
        '401':
          description: Unauthorized.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '403':
          description: Forbidden.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '429':
          description: Too many requests.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
        '503':
          description: Service unavailable.
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
          x-ms-error-response: true
      x-ms-examples:
        Delete message:
          $ref: ./examples/Messages_DeleteChatMessage.json
      description: Needs a more full description created.
definitions:
  CommunicationErrorResponse:
    $ref: ../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationErrorResponse
  SendChatMessageResult:
    description: Result of the send message operation.
    required:
    - id
    type: object
    properties:
      id:
        description: A server-generated message id.
        type: string
        example: '123456789'
  CommunicationIdentifierModel:
    $ref: ../../../Common/stable/2023-11-15/common.json#/definitions/CommunicationIdentifierModel
  ChatMessage:
    description: Chat message.
    required:
    - createdOn
    - id
    - sequenceId
    - type
    - version
    type: object
    properties:
      id:
        description: The id of the chat message. This id is server generated.
        type: string
        example: '123456789'
      type:
        $ref: '#/definitions/ChatMessageType'
      sequenceId:
        description: Sequence of the chat message in the conversation.
        type: string
      version:
        description: Version of the chat message.
        type: string
      content:
        $ref: '#/definitions/ChatMessageContent'
      senderDisplayName:
        description: The display name of the chat message sender. This property is used to populate sender name for push notifications.
        type: string
        example: Jane
      createdOn:
        format: date-time
        description: 'The timestamp when the chat message arrived at the server. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2020-10-30T10:50:50Z'
      senderCommunicationIdentifier:
        $ref: '#/definitions/CommunicationIdentifierModel'
      deletedOn:
        format: date-time
        description: 'The timestamp (if applicable) when the message was deleted. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2020-10-30T10:50:50Z'
      editedOn:
        format: date-time
        description: 'The last timestamp (if applicable) when the message was edited. The timestamp is in RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.'
        type: string
        example: '2020-10-30T10:50:50Z'
      metadata:
        description: Message metadata.
        type: object
        additionalProperties:
          type: string
  ChatMessageType:
    description: The chat message type.
    enum:
    - text
    - html
    - topicUpdated
    - participantAdded
    - participantRemoved
    type: string
    x-ms-enum:
      name: ChatMessageType
      modelAsString: true
    example: html
  UpdateChatMessageRequest:
    description: Request payload for updating a chat message.
    type: object
    properties:
      content:
        description: Chat message content.
        type: string
        example: Let's go for lunch together.
      metadata:
        description: Message metadata.
        type: object
        additionalProperties:
          type: string
      attachments:
        description: The array of attachments
        type: array
        items:
          $ref: '#/definitions/ChatAttachment'
  ChatMessageContent:
    description: Content of a chat message.
    type: object
    properties:
      message:
        description: Chat message content for messages of types text or html.
        type: string
        example: <p>Come one guys, lets go for lunch together.</p><img id="f508ce15-e878-431f-b871-f530cac5331d">
      topic:
        description: Chat message content for messages of type topicUpdated.
        type: string
        example: Lunch Chat thread
      participants:
        description: Chat message content for messages of types participantAdded or participantRemoved.
        type: array
        items:
          $ref: '#/definitions/ChatParticipant'
      attachments:
        description: List of attachments for this message
        type: array
        items:
          $ref: '#/definitions/ChatAttachment'
      initiatorCommunicationIdentifier:
        $ref: '#/definitions/CommunicationIdentifierModel'
  SendChatMessageRequest:
    description: Details of the message to send.
    required:
    - content
    type: object
    properties:
      content:
        description: Chat message content.
        type: string
        example: <p>Come one guys, lets go for lunch together.</p>
      senderDisplayName:
        description: The display name of the chat message sender. This property is used to populate sender name for push notifications.
        type: string
        example: Bob Admin
      type:
        $ref: '#/definitions/ChatMessageType'
      metadata:
        description: Message metadata.
        type: object
        additionalProperties:
          type: string
      attachments:
        description: The array of attachments
        type: array
        items:
          $ref: '#/definitions/ChatAttachment'
  ChatParticipant:
    description: A participant of the chat thread.
    required:
    - communicationIdentifier
    type: object
    properties:
      communicationIdentifier:
        $ref: '#/definitions/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
  ChatMessagesCollection:
    description: Collection of chat messages for a particular chat thread.
    required:
    - value
    type: object
    properties:
      value:
        description: Collection of chat messages.
        type: array
        items:
          $ref: '#/definitions/ChatMessage'
      nextLink:
        description: If there are more chat messages that can be retrieved, the next link will be populated.
        type: string
        readOnly: true
  ChatAttachmentType:
    description: The type of attachment.
    enum:
    - image
    - file
    type: string
    x-ms-enum:
      name: ChatAttachmentType
      modelAsString: true
  ChatAttachment:
    description: An attachment in a chat message. Currently only supported in Teams Interop scenarios.
    required:
    - id
    - attachmentType
    type: object
    properties:
      id:
        description: Id of the attachment
        type: string
        example: f508ce15-e878-431f-b871-f530cac5331d
      attachmentType:
        $ref: '#/definitions/ChatAttachmentType'
      name:
        description: The name of the attachment content.
        type: string
        example: SomeImage.png
      url:
        description: The URL where the attachment can be downloaded
        type: string
        format: uri
        example: https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/original
      previewUrl:
        description: The URL where the preview of attachment can be downloaded
        type: string
        format: uri
        example: https://{geoChatGW}/threads/{chatThreadId}/images/{imageId}/views/small
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'