swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Sms API
schemes:
- https
tags:
- name: Sms
paths:
  /sms:
    post:
      tags:
      - Sms
      summary: Microsoft Azure Sends A Sms Message From A Phone Number That Belongs To The Authenticated Account
      operationId: microsoftAzureSmsSend
      x-ms-examples:
        SuccessfulSend:
          $ref: ./examples/send.json
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: SendMessageRequest
        description: Represents the body of the send message request.
        required: true
        schema:
          $ref: '#/definitions/SendMessageRequest'
      - name: api-version
        in: query
        description: Version of API to invoke.
        required: true
        type: string
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/SmsSendResponse'
      description: Needs a more full description created.
definitions:
  SmsSendResponseItem:
    description: Response for a single recipient.
    required:
    - httpStatusCode
    - to
    - successful
    type: object
    properties:
      to:
        description: The recipient's phone number in E.164 format.
        type: string
      messageId:
        description: The identifier of the outgoing Sms message. Only present if message processed.
        type: string
      httpStatusCode:
        description: HTTP Status code.
        type: integer
      repeatabilityResult:
        description: The result of a repeatable request with one of the case-insensitive values accepted or rejected.
        type: string
        enum:
        - accepted
        - rejected
      successful:
        description: Indicates if the message is processed successfully or not.
        type: boolean
      errorMessage:
        description: Optional error message in case of 4xx/5xx/repeatable errors.
        type: string
  SmsSendOptions:
    description: Optional configuration for sending SMS messages.
    required:
    - enableDeliveryReport
    type: object
    properties:
      enableDeliveryReport:
        description: Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid.
        type: boolean
      tag:
        description: Use this field to provide metadata that will then be sent back in the corresponding Delivery Report.
        type: string
  SmsRecipient:
    description: Recipient details for sending SMS messages.
    required:
    - to
    type: object
    properties:
      to:
        description: The recipient's phone number in E.164 format.
        type: string
      repeatabilityRequestId:
        description: If specified, the client directs that the request is repeatable; that is, 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, 36-character hexadecimal case-insensitive encoding of a UUID (GUID), identifier for the request.
        type: string
      repeatabilityFirstSent:
        description: MUST be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created.eg- Tue, 26 Mar 2019 16:06:51 GMT
        type: string
  SendMessageRequest:
    description: Represents the properties of a send message request.
    required:
    - message
    - smsRecipients
    - from
    type: object
    properties:
      from:
        description: The sender's phone number in E.164 format that is owned by the authenticated account.
        type: string
      smsRecipients:
        description: The recipient's phone number in E.164 format. In this version, a minimum of 1 and upto 100 recipients in the list are supported.
        maxLength: 100
        minLength: 1
        type: array
        items:
          $ref: '#/definitions/SmsRecipient'
      message:
        description: The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724.
        maxLength: 2048
        minLength: 0
        type: string
      smsSendOptions:
        $ref: '#/definitions/SmsSendOptions'
  SmsSendResponse:
    description: Response for a successful or multi status send Sms request.
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/SmsSendResponseItem'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'