swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector PreConnections API
schemes:
- https
tags:
- name: PreConnections
paths:
  /calling/callConnections:
    post:
      tags:
      - PreConnections
      summary: Microsoft Azure Create An Outbound Call
      description: Create an outbound call.
      operationId: microsoftAzureServercallingCreatecall
      parameters:
      - name: createCallRequest
        in: body
        description: The create call request.
        required: true
        schema:
          $ref: '#/definitions/CreateCallRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: Repeatability-Request-ID
        in: header
        description: If specified, the client directs that the request is repeatable; that is, that 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 unique identifier for the request. It is a version 4 (random) UUID.
        type: string
        format: uuid
      - name: Repeatability-First-Sent
        in: header
        description: 'If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.'
        type: string
      responses:
        '201':
          description: Returns the create call response.
          schema:
            $ref: '#/definitions/CallConnectionProperties'
        default:
          description: Error
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
      x-ms-examples:
        Create an outbound call.:
          $ref: ./examples/ServerCalling_CreateCall.json
  /calling/callConnections:answer:
    post:
      tags:
      - PreConnections
      summary: Microsoft Azure Answer A Call
      description: Answer a call using the IncomingCallContext from Event Grid.
      operationId: microsoftAzureServercallingAnswercall
      parameters:
      - name: answerCallRequest
        in: body
        description: The answer call request.
        required: true
        schema:
          $ref: '#/definitions/AnswerCallRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: Repeatability-Request-ID
        in: header
        description: If specified, the client directs that the request is repeatable; that is, that 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 unique identifier for the request. It is a version 4 (random) UUID.
        type: string
        format: uuid
      - name: Repeatability-First-Sent
        in: header
        description: 'If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.'
        type: string
      responses:
        '200':
          description: Returns the answer call response.
          schema:
            $ref: '#/definitions/CallConnectionProperties'
        default:
          description: Error
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
      x-ms-examples:
        Answer a Call.:
          $ref: ./examples/ServerCalling_AnswerCall.json
  /calling/callConnections:redirect:
    post:
      tags:
      - PreConnections
      summary: Microsoft Azure Redirect A Call
      description: Redirect a call.
      operationId: microsoftAzureServercallingRedirectcall
      parameters:
      - name: redirectCallRequest
        in: body
        description: The redirect call request.
        required: true
        schema:
          $ref: '#/definitions/RedirectCallRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: Repeatability-Request-ID
        in: header
        description: If specified, the client directs that the request is repeatable; that is, that 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 unique identifier for the request. It is a version 4 (random) UUID.
        type: string
        format: uuid
      - name: Repeatability-First-Sent
        in: header
        description: 'If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.'
        type: string
      responses:
        '204':
          description: Returns the redirect call response.
        default:
          description: Error
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
      x-ms-examples:
        Redirect a call.:
          $ref: ./examples/ServerCalling_RedirectCall.json
  /calling/callConnections:reject:
    post:
      tags:
      - PreConnections
      summary: Microsoft Azure Reject The Call
      description: Reject the call.
      operationId: microsoftAzureServercallingRejectcall
      parameters:
      - name: rejectCallRequest
        in: body
        description: The reject call request.
        required: true
        schema:
          $ref: '#/definitions/RejectCallRequest'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: Repeatability-Request-ID
        in: header
        description: If specified, the client directs that the request is repeatable; that is, that 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 unique identifier for the request. It is a version 4 (random) UUID.
        type: string
        format: uuid
      - name: Repeatability-First-Sent
        in: header
        description: 'If Repeatability-Request-ID header is specified, then Repeatability-First-Sent header must also be specified. The value should be the date and time at which the request was first created, expressed using the IMF-fixdate form of HTTP-date. Example: Sun, 06 Nov 1994 08:49:37 GMT.'
        type: string
      responses:
        '204':
          description: Returns the reject call response.
        default:
          description: Error
          schema:
            $ref: '#/definitions/CommunicationErrorResponse'
      x-ms-examples:
        Reject the call.:
          $ref: ./examples/ServerCalling_RejectCall.json
definitions:
  CommunicationErrorResponse:
    description: The Communication Services error response
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/CommunicationError'
  CreateCallRequest:
    description: The request payload for creating the call.
    required:
    - targets
    - source
    - callbackUri
    type: object
    properties:
      targets:
        description: The targets of the call.
        type: array
        items:
          $ref: '#/definitions/CommunicationIdentifierModel'
      source:
        $ref: '#/definitions/CallSource'
        description: The source of the call.
      operationContext:
        description: A customer set value used to track the answering of a call.
        type: string
      callbackUri:
        description: The callback URI.
        type: string
      mediaStreamingConfiguration:
        $ref: '#/definitions/MediaStreamingConfiguration'
        description: Media Streaming Configuration.
  MediaStreamingAudioChannelType:
    description: Audio channel type to stream, eg. unmixed audio, mixed audio
    enum:
    - mixed
    - unmixed
    type: string
    x-ms-enum:
      name: MediaStreamingAudioChannelType
      modelAsString: true
  CallConnectionProperties:
    description: Properties of a call connection
    type: object
    properties:
      callConnectionId:
        description: The call connection id.
        type: string
      serverCallId:
        description: The server call id.
        type: string
      source:
        $ref: '#/definitions/CallSource'
        description: The source of the call, which is the caller.
      targets:
        description: The targets of the call.
        type: array
        items:
          $ref: '#/definitions/CommunicationIdentifierModel'
      callConnectionState:
        $ref: '#/definitions/CallConnectionStateModel'
      callbackUri:
        description: The callback URI.
        type: string
      mediaSubscriptionId:
        description: SubscriptionId for media streaming
        type: string
  MediaStreamingConfiguration:
    description: Configuration of Media streaming.
    required:
    - transportUrl
    - transportType
    - contentType
    - audioChannelType
    type: object
    properties:
      transportUrl:
        description: Transport URL for media streaming
        type: string
      transportType:
        $ref: '#/definitions/MediaStreamingTransportType'
      contentType:
        $ref: '#/definitions/MediaStreamingContentType'
      audioChannelType:
        $ref: '#/definitions/MediaStreamingAudioChannelType'
  CommunicationCloudEnvironmentModel:
    enum:
    - public
    - dod
    - gcch
    type: string
    x-ms-enum:
      name: CommunicationCloudEnvironmentModel
      modelAsString: true
  CommunicationError:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/CommunicationError'
      innererror:
        $ref: '#/definitions/CommunicationError'
  CallSource:
    description: The caller.
    required:
    - identifier
    type: object
    properties:
      callerId:
        $ref: '#/definitions/PhoneNumberIdentifierModel'
        description: "The source caller Id, a phone number, that's shown to the PSTN participant being invited. \r\nRequired only when calling a PSTN callee."
      displayName:
        description: Display name of the call if dialing out to a pstn number
        type: string
      identifier:
        $ref: '#/definitions/CommunicationIdentifierModel'
        description: The identifier of the source of the call
  CommunicationUserIdentifierModel:
    required:
    - id
    type: object
    properties:
      id:
        type: string
  MicrosoftTeamsUserIdentifierModel:
    required:
    - userId
    type: object
    properties:
      userId:
        type: string
      isAnonymous:
        type: boolean
      cloud:
        $ref: '#/definitions/CommunicationCloudEnvironmentModel'
  CallRejectReason:
    description: The rejection reason.
    enum:
    - none
    - busy
    - forbidden
    type: string
    x-ms-enum:
      name: CallRejectReason
      modelAsString: true
  CommunicationIdentifierModelKind:
    description: Type of CommunicationIdentifierModel.
    enum:
    - unknown
    - communicationUser
    - phoneNumber
    - microsoftTeamsUser
    type: string
    x-ms-enum:
      name: CommunicationIdentifierModelKind
      modelAsString: true
  CommunicationIdentifierModel:
    type: object
    properties:
      rawId:
        description: Full ID of the identifier.
        type: string
      kind:
        $ref: '#/definitions/CommunicationIdentifierModelKind'
      communicationUser:
        $ref: '#/definitions/CommunicationUserIdentifierModel'
        description: The communication user.
      phoneNumber:
        $ref: '#/definitions/PhoneNumberIdentifierModel'
        description: The phone number.
      microsoftTeamsUser:
        $ref: '#/definitions/MicrosoftTeamsUserIdentifierModel'
        description: The Microsoft Teams user.
  MediaStreamingTransportType:
    description: The type of transport to be used for media streaming, eg. Websocket
    enum:
    - websocket
    type: string
    x-ms-enum:
      name: MediaStreamingTransportType
      modelAsString: true
  AnswerCallRequest:
    description: The request payload for answering the call.
    required:
    - incomingCallContext
    - callbackUri
    type: object
    properties:
      incomingCallContext:
        description: The context associated with the call.
        type: string
      callbackUri:
        description: The callback uri.
        type: string
      mediaStreamingConfiguration:
        $ref: '#/definitions/MediaStreamingConfiguration'
        description: Media Streaming Configuration.
  RedirectCallRequest:
    description: The request payload for redirecting the call.
    required:
    - incomingCallContext
    - target
    type: object
    properties:
      incomingCallContext:
        description: The context associated with the call.
        type: string
      target:
        $ref: '#/definitions/CommunicationIdentifierModel'
        description: The target identity to redirect the call to.
  CallConnectionStateModel:
    description: The state of the call connection.
    enum:
    - unknown
    - connecting
    - connected
    - transferring
    - transferAccepted
    - disconnecting
    - disconnected
    type: string
    x-ms-enum:
      name: CallConnectionStateModel
      modelAsString: true
  RejectCallRequest:
    description: The request payload for rejecting the call.
    required:
    - incomingCallContext
    type: object
    properties:
      incomingCallContext:
        description: The context associated with the call.
        type: string
      callRejectReason:
        $ref: '#/definitions/CallRejectReason'
  PhoneNumberIdentifierModel:
    required:
    - value
    type: object
    properties:
      value:
        type: string
  MediaStreamingContentType:
    description: Content type to stream, eg. audio, audio/video
    enum:
    - audio
    type: string
    x-ms-enum:
      name: MediaStreamingContentType
      modelAsString: true
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Version of API to invoke.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'