swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Recording API
schemes:
- https
tags:
- name: Recording
paths:
  /calling/serverCalls/{serverCallId}/recordings:
    post:
      tags:
      - Recording
      summary: Microsoft Azure Start Recording Of The Call
      operationId: microsoftAzureServercallsStartrecording
      parameters:
      - name: serverCallId
        in: path
        description: The server call id.
        required: true
        type: string
      - name: request
        in: body
        description: The request body of start call recording request.
        required: true
        schema:
          $ref: '#/definitions/StartCallRecordingRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the start call recording response.
          schema:
            $ref: '#/definitions/StartCallRecordingResult'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      x-ms-examples:
        Start recording of the call.:
          $ref: ./examples/ServerCalls_StartRecording.json
      description: Needs a more full description created.
  /calling/serverCalls/{serverCallId}/recordings/{recordingId}:
    get:
      tags:
      - Recording
      summary: Microsoft Azure Get Call Recording Properties
      operationId: microsoftAzureServercallsGetrecordingproperties
      parameters:
      - name: serverCallId
        in: path
        description: The server call id.
        required: true
        type: string
      - name: recordingId
        in: path
        description: The recording id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the recording state.
          schema:
            $ref: '#/definitions/CallRecordingProperties'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      x-ms-examples:
        Get call recording properties.:
          $ref: ./examples/ServerCalls_GetRecordingProperties.json
      description: Needs a more full description created.
    delete:
      tags:
      - Recording
      summary: Microsoft Azure Stop Recording The Call
      operationId: microsoftAzureServercallsStoprecording
      parameters:
      - name: serverCallId
        in: path
        description: The server call id.
        required: true
        type: string
      - name: recordingId
        in: path
        description: The recording id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the stop call recording response.
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      x-ms-examples:
        Stop recording the call.:
          $ref: ./examples/ServerCalls_StopRecording.json
      description: Needs a more full description created.
  /calling/serverCalls/{serverCallId}/recordings/{recordingId}/:pause:
    post:
      tags:
      - Recording
      summary: Microsoft Azure Pause Recording The Call
      operationId: microsoftAzureServercallsPauserecording
      parameters:
      - name: serverCallId
        in: path
        description: The server call id.
        required: true
        type: string
      - name: recordingId
        in: path
        description: The recording id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the pause call recording response.
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      x-ms-examples:
        Pause recording the call.:
          $ref: ./examples/ServerCalls_PauseRecording.json
      description: Needs a more full description created.
  /calling/serverCalls/{serverCallId}/recordings/{recordingId}/:resume:
    post:
      tags:
      - Recording
      summary: Microsoft Azure Resume Recording The Call
      operationId: microsoftAzureServercallsResumerecording
      parameters:
      - name: serverCallId
        in: path
        description: The server call id.
        required: true
        type: string
      - name: recordingId
        in: path
        description: The recording id.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Returns the resume call recording response.
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      x-ms-examples:
        Resume recording the call.:
          $ref: ./examples/ServerCalls_ResumeRecording.json
      description: Needs a more full description created.
definitions:
  CallRecordingState:
    description: The state of the recording
    enum:
    - active
    - inactive
    type: string
    x-ms-enum:
      name: CallRecordingState
      modelAsString: true
  CommunicationErrorResponse:
    $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
  CallRecordingProperties:
    description: The response payload of get call recording properties operation.
    required:
    - recordingState
    type: object
    properties:
      recordingState:
        $ref: '#/definitions/CallRecordingState'
  StartCallRecordingResult:
    description: The response payload of start call recording operation.
    type: object
    properties:
      recordingId:
        description: The recording id of the started recording
        type: string
  StartCallRecordingRequest:
    description: The request payload start call recording operation.
    type: object
    properties:
      recordingStateCallbackUri:
        description: The uri to send notifications to.
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
responses:
  '500':
    description: InternalServerError
    schema:
      $ref: '#/definitions/CommunicationErrorResponse'
    x-ms-error-response: true
  '404':
    description: NotFound
    schema:
      $ref: '#/definitions/CommunicationErrorResponse'
    x-ms-error-response: true
  '403':
    description: Forbidden
    schema:
      $ref: '#/definitions/CommunicationErrorResponse'
    x-ms-error-response: true
  '400':
    description: BadRequest
    schema:
      $ref: '#/definitions/CommunicationErrorResponse'
    x-ms-error-response: true
  '401':
    description: Unauthorized
    schema:
      $ref: '#/definitions/CommunicationErrorResponse'
    x-ms-error-response: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'