Microsoft Azure Communication Services Notifications API

openapi: 3.2.0
info:
  title: CommunicationMessagesClient Notifications API
  version: '2024-08-30'
  description: Azure Communication Messages Service
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
security:
- AadOauth2Auth:
  - https://communication.azure.com/.default
- ApiKeyAuth: []
tags:
- name: Notifications
paths:
  /messages/notifications:send:
    post:
      operationId: NotificationMessagesOperations_Send
      tags:
      - Notifications
      description: Sends a notification message from Business to User.
      parameters:
      - $ref: '#/components/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/components/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/components/parameters/Azure.Core.ClientRequestIdHeader'
      - $ref: '#/components/parameters/NotificationMessagesSendRequestBody'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          headers:
            Repeatability-Result:
              description: Indicates whether the repeatable request was accepted or rejected.
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
              schema:
                type: string
                enum:
                - accepted
                - rejected
            x-ms-client-request-id:
              description: An opaque, globally-unique, client-generated string identifier for the request.
              schema:
                type: string
                format: uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendMessageResult'
        default:
          description: An unexpected error response.
          headers:
            x-ms-error-code:
              description: String error code indicating what went wrong.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Azure.Core.Foundations.ErrorResponse'
      summary: Notification messages operations send
      x-summary-source: derived
components:
  schemas:
    NotificationContent:
      type: object
      description: Details of the message to send.
      properties:
        channelRegistrationId:
          $ref: '#/components/schemas/Azure.Core.uuid'
          description: The Channel Registration ID for the Business Identifier.
        to:
          type: array
          description: The native external platform user identifiers of the recipient.
          items:
            type: string
        kind:
          $ref: '#/components/schemas/CommunicationMessageKind'
          description: The type discriminator describing a message type.
      discriminator:
        propertyName: kind
      required:
      - channelRegistrationId
      - to
      - kind
    MessageReceipt:
      type: object
      description: Receipt of the sending one message.
      properties:
        messageId:
          type: string
          description: The message id.
        to:
          type: string
          description: The native external platform user identifier of the recipient.
      required:
      - messageId
      - to
    Azure.Core.Foundations.ErrorResponse:
      type: object
      description: A response containing error details.
      properties:
        error:
          $ref: '#/components/schemas/Azure.Core.Foundations.Error'
          description: The error object.
      required:
      - error
    SendMessageResult:
      type: object
      description: Result of the send message operation.
      properties:
        receipts:
          type: array
          description: Receipts of the send message operation.
          items:
            $ref: '#/components/schemas/MessageReceipt'
      required:
      - receipts
    CommunicationMessageKind:
      type: string
      description: The type of message.
      enum:
      - text
      - image
      - image_v0
      - document
      - video
      - audio
      - template
      x-ms-enum:
        name: CommunicationMessageKind
        modelAsString: true
        values:
        - name: text
          value: text
          description: Text message type.
        - name: image
          value: image
          description: Image message type.
        - name: image_v0
          value: image_v0
          description: Image message type. Legacy image type for `MediaNotificationContent` which is being deprecated
        - name: document
          value: document
          description: Document message type.
        - name: video
          value: video
          description: Video message type.
        - name: audio
          value: audio
          description: Audio message type.
        - name: template
          value: template
          description: Template message type.
    Azure.Core.uuid:
      type: string
      format: uuid
      description: Universally Unique Identifier
    Azure.Core.Foundations.InnerError:
      type: object
      description: An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: Inner error.
    Azure.Core.Foundations.Error:
      type: object
      description: The error object.
      properties:
        code:
          type: string
          description: One of a server-defined set of error codes.
        message:
          type: string
          description: A human-readable representation of the error.
        target:
          type: string
          description: The target of the error.
        details:
          type: array
          description: An array of details about specific errors that led to this reported error.
          items:
            $ref: '#/components/schemas/Azure.Core.Foundations.Error'
        innererror:
          $ref: '#/components/schemas/Azure.Core.Foundations.InnerError'
          description: An object containing more specific information than the current object about the error.
      required:
      - code
      - message
  parameters:
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId:
      name: Repeatability-Request-ID
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityRequestId
      schema:
        type: string
    Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent:
      name: Repeatability-First-Sent
      in: header
      description: Specifies the date and time at which the request was first created.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: repeatabilityFirstSent
      schema:
        type: string
        format: date-time
    NotificationMessagesSendRequestBody:
      name: body
      in: body
      description: Details of the message to send.
      required: true
      schema:
        $ref: '#/components/schemas/NotificationContent'
      x-ms-parameter-location: method
    Azure.Core.ClientRequestIdHeader:
      name: x-ms-client-request-id
      in: header
      description: An opaque, globally-unique, client-generated string identifier for the request.
      required: false
      x-ms-parameter-location: method
      x-ms-client-name: clientRequestId
      schema:
        type: string
        format: uuid
    Azure.Core.Foundations.ApiVersionParameter:
      name: api-version
      in: query
      description: The API version to use for this operation.
      required: true
      x-ms-parameter-location: method
      x-ms-client-name: apiVersion
      schema:
        type: string
        minLength: 1
  securitySchemes:
    AadOauth2Auth:
      type: oauth2
      flows:
        authorizationCode:
          scopes:
            https://communication.azure.com/.default: ''
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/token
      description: The Azure Active Directory OAuth2 Flow
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - name: endpoint
    in: path
    description: The communication resource, for example https://my-resource.communication.azure.com
    required: true
    type: string
    format: uri
    x-ms-skip-url-encoding: true