Microsoft Azure CallConnection API

openapi: 3.2.0
info:
  version: 2021-06-15-preview
  title: Microsoft Azure Azure Communication CallingServer Service…
  description: Azure Communication CallingServer Service
tags:
- name: CallConnection
paths:
  /calling/callConnections:
    post:
      tags:
      - CallConnection
      summary: Microsoft Azure Create A New Call
      description: Create a new call.
      operationId: microsoftAzureCallconnectionsCreatecall
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '201':
          description: Returns the create call response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCallResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Create a new call.:
          $ref: ./examples/CallConnections_CreateCall.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCallRequest'
        description: Create call request.
        required: true
  /calling/callConnections/{callConnectionId}/:hangup:
    post:
      tags:
      - CallConnection
      summary: Microsoft Azure Hangup The Call
      description: Hangup the call.
      operationId: microsoftAzureCallconnectionsHangupcall
      parameters:
      - name: callConnectionId
        in: path
        description: The call connection id.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Returns the hangup call response.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Hangup the call.:
          $ref: ./examples/CallConnections_HangupCall.json
  /calling/callConnections/{callConnectionId}/:playAudio:
    post:
      tags:
      - CallConnection
      summary: Microsoft Azure Play Audio In The Call
      description: Play audio in the call.
      operationId: microsoftAzureCallconnectionsPlayaudio
      parameters:
      - name: callConnectionId
        in: path
        description: The call connection id.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Returns the play audio response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlayAudioResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Play audio in the call.:
          $ref: ./examples/CallConnections_PlayAudio.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlayAudioRequest'
        description: Play audio request.
        required: true
  /calling/callConnections/{callConnectionId}/:cancelAllMediaOperations:
    post:
      tags:
      - CallConnection
      summary: Microsoft Azure Cancel All Media Operations
      description: Cancel all media operations.
      operationId: microsoftAzureCallconnectionsCancelallmediaoperations
      parameters:
      - name: callConnectionId
        in: path
        description: The call connection id
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the cancel all media operations response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelAllMediaOperationsResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Cancel all media operations.:
          $ref: ./examples/CallConnections_CancelAllMediaOperations.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelAllMediaOperationsRequest'
        description: The cancel all media operations context.
        required: true
  /calling/callConnections/{callConnectionId}/participants:
    post:
      tags:
      - CallConnection
      summary: Microsoft Azure Add A Participant To The Call
      description: Add a participant to the call.
      operationId: microsoftAzureCallconnectionsAddparticipant
      parameters:
      - name: callConnectionId
        in: path
        description: The call connection id.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Returns the add participant response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddParticipantResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Add a participant to the call.:
          $ref: ./examples/CallConnections_AddParticipant.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddParticipantRequest'
        description: Add participant request.
        required: true
  /calling/callConnections/{callConnectionId}/participants/{participantId}:
    delete:
      tags:
      - CallConnection
      summary: Microsoft Azure Remove A Participant From The Call
      description: Remove a participant from the call.
      operationId: microsoftAzureCallconnectionsRemoveparticipant
      parameters:
      - name: callConnectionId
        in: path
        description: The call connection id.
        required: true
        schema:
          type: string
      - name: participantId
        in: path
        description: The participant id.
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '202':
          description: Returns the remove participant response.
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      x-ms-examples:
        Remove a participant from the call.:
          $ref: ./examples/CallConnections_RemoveParticipant.json
components:
  schemas:
    AddParticipantRequest:
      description: The add participant request.
      type: object
      properties:
        alternateCallerId:
          $ref: '#/components/schemas/PhoneNumberIdentifier'
          description: The alternate identity of source participant.
        participant:
          $ref: '#/components/schemas/CommunicationIdentifier'
          description: The participant to be added to the call.
        operationContext:
          description: The operation context.
          type: string
        callbackUri:
          description: The callback URI.
          type: string
    PlayAudioRequest:
      description: The request payload for playing audio.
      type: object
      properties:
        audioFileUri:
          description: "The media resource uri of the play audio request. \nCurrently only Wave file (.wav) format audio prompts are supported.\nMore specifically, the audio content in the wave file must be mono (single-channel),\n16-bit samples with a 16,000 (16KHz) sampling rate."
          type: string
        loop:
          description: The flag indicating whether audio file needs to be played in loop or not.
          type: boolean
        operationContext:
          description: The value to identify context of the operation.
          type: string
        audioFileId:
          description: An id for the media in the AudioFileUri, using which we cache the media resource.
          type: string
        callbackUri:
          description: The callback Uri to receive PlayAudio status notifications.
          type: string
    PhoneNumberIdentifier:
      $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/PhoneNumberIdentifierModel
    OperationStatus:
      description: The status of the operation
      enum:
      - notStarted
      - running
      - completed
      - failed
      type: string
      x-ms-enum:
        name: OperationStatus
        modelAsString: true
    MediaType:
      enum:
      - audio
      - video
      type: string
      x-ms-enum:
        name: MediaType
        modelAsString: true
    AddParticipantResult:
      description: The add participant result
      type: object
      properties:
        participantId:
          description: The id of the added participant.
          type: string
    ResultInfo:
      description: Result info class to be used to report result status for actions/operations.
      required:
      - code
      - subcode
      type: object
      properties:
        code:
          format: int32
          description: The result code associated with the operation.
          type: integer
        subcode:
          format: int32
          description: The subcode that further classifies the result.
          type: integer
        message:
          description: The message is a detail explanation of subcode.
          type: string
    EventSubscriptionType:
      enum:
      - participantsUpdated
      - dtmfReceived
      type: string
      x-ms-enum:
        name: EventSubscriptionType
        modelAsString: true
    CreateCallRequest:
      description: The request payload for create call.
      required:
      - targets
      - source
      - callbackUri
      type: object
      properties:
        alternateCallerId:
          $ref: '#/components/schemas/PhoneNumberIdentifier'
          description: The alternate identity of the source of the call if dialing out to a pstn number
        targets:
          description: The targets of the call.
          type: array
          items:
            $ref: '#/components/schemas/CommunicationIdentifier'
        source:
          $ref: '#/components/schemas/CommunicationIdentifier'
          description: The source of the call.
        subject:
          description: The subject.
          type: string
        callbackUri:
          description: The callback URI.
          type: string
        requestedMediaTypes:
          description: The requested modalities.
          type: array
          items:
            $ref: '#/components/schemas/MediaType'
        requestedCallEvents:
          description: The requested call events to subscribe to.
          type: array
          items:
            $ref: '#/components/schemas/EventSubscriptionType'
    CancelAllMediaOperationsResult:
      description: The response payload of the cancel all media operations.
      required:
      - status
      type: object
      properties:
        operationId:
          description: The operation id.
          type: string
        status:
          $ref: '#/components/schemas/OperationStatus'
        operationContext:
          description: The operation context provided by client.
          type: string
        resultInfo:
          $ref: '#/components/schemas/ResultInfo'
          description: The result info for the operation.
    CancelAllMediaOperationsRequest:
      description: The request payload for cancel all media operations
      type: object
      properties:
        operationContext:
          description: The context for this operation.
          type: string
    CommunicationErrorResponse:
      $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
    CreateCallResult:
      description: The response payload of the create call operation.
      type: object
      properties:
        callConnectionId:
          description: The call connection id.
          type: string
    PlayAudioResult:
      description: The response payload for play audio operation.
      required:
      - status
      type: object
      properties:
        operationId:
          description: The operation id.
          type: string
        status:
          $ref: '#/components/schemas/OperationStatus'
        operationContext:
          description: The operation context provided by client.
          type: string
        resultInfo:
          $ref: '#/components/schemas/ResultInfo'
          description: The result info for the operation.
    CommunicationIdentifier:
      $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel
  responses:
    '401':
      description: Unauthorized
      x-ms-error-response: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommunicationErrorResponse'
    '500':
      description: InternalServerError
      x-ms-error-response: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommunicationErrorResponse'
    '404':
      description: NotFound
      x-ms-error-response: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CommunicationErrorResponse'
    '400':
      description: BadRequest
      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'
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      description: Version of API to invoke.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'