Microsoft SMS API

openapi: 3.2.0
info:
  title: Microsoft Azure Communication Services SMS API
  description: Multichannel communication APIs for adding voice, video, chat, SMS, and email capabilities to applications.
  version: '2024-03-15'
  contact:
    name: Azure Communication Services Support
    url: https://learn.microsoft.com/en-us/azure/communication-services/
  termsOfService: https://www.microsoft.com/en-us/legal/terms-of-use
servers:
- url: https://{resource}.communication.azure.com
  description: Azure Communication Services Endpoint
  variables:
    resource:
      default: your-resource
      description: Your Communication Services resource name
security:
- accessKey: []
tags:
- name: SMS
  description: Send SMS messages
paths:
  /sms:
    post:
      operationId: sendSms
      summary: Microsoft Send an SMS message
      description: Send a single SMS message or a batch of SMS messages.
      tags:
      - SMS
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendSmsRequest'
      responses:
        '202':
          description: SMS accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsSendResult'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
components:
  parameters:
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version
      schema:
        type: string
        default: 2024-03-15-preview
  schemas:
    SmsSendResult:
      type: object
      properties:
        value:
          type: array
          items:
            type: object
            properties:
              to:
                type: string
              messageId:
                type: string
              httpStatusCode:
                type: integer
              successful:
                type: boolean
              errorMessage:
                type: string
    SendSmsRequest:
      type: object
      required:
      - from
      - smsRecipients
      - message
      properties:
        from:
          type: string
          description: Sender phone number in E.164 format
        smsRecipients:
          type: array
          items:
            type: object
            required:
            - to
            properties:
              to:
                type: string
                description: Recipient phone number in E.164 format
        message:
          type: string
          description: The message body (max 2048 characters)
          maxLength: 2048
        smsSendOptions:
          type: object
          properties:
            enableDeliveryReport:
              type: boolean
              default: false
            tag:
              type: string
  securitySchemes:
    accessKey:
      type: apiKey
      name: Authorization
      in: header
      description: HMAC-SHA256 signature authentication
externalDocs:
  description: Azure Communication Services REST API Reference
  url: https://learn.microsoft.com/en-us/rest/api/communication/