Microsoft Azure Communications API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Communications API
schemes:
- https
tags:
- name: Communications
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability:
    post:
      tags:
      - Communications
      description: Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
      operationId: microsoftAzureCommunicationsChecknameavailability
      x-ms-examples:
        Checks whether name is available for Communication resource:
          $ref: ./examples/CheckNameAvailabilityForSupportTicketCommunication.json
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: checkNameAvailabilityInput
        in: body
        description: Input to check.
        required: true
        schema:
          $ref: '#/definitions/CheckNameAvailabilityInput'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/CheckNameAvailabilityOutput'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname Checknameavailability
  /providers/Microsoft.Support/supportTickets/{supportTicketName}/checkNameAvailability:
    post:
      tags:
      - Communications
      description: Check the availability of a resource name. This API should be used to check the uniqueness of the name for adding a new communication to the support ticket.
      operationId: microsoftAzureCommunicationsnosubscriptionChecknameavailability
      x-ms-examples:
        Checks whether name is available for Communication resource:
          $ref: ./examples/CheckNameAvailabilityForNoSubscriptionSupportTicketCommunication.json
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: checkNameAvailabilityInput
        in: body
        description: Input to check.
        required: true
        schema:
          $ref: '#/definitions/CheckNameAvailabilityInput'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/CheckNameAvailabilityOutput'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Post Providers Microsoft Support Supporttickets Supportticketname Checknameavailability
  /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications:
    get:
      tags:
      - Communications
      description: Lists all communications (attachments not included) for a support ticket.  You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
      operationId: microsoftAzureCommunicationsList
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: $top
        in: query
        description: The number of values to return in the collection. Default is 10 and max is 10.
        required: false
        type: integer
        format: int32
      - name: $filter
        in: query
        required: false
        type: string
        description: The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved communications for a support ticket.
          schema:
            $ref: '#/definitions/CommunicationsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List communications for a subscription support ticket:
          $ref: ./examples/ListCommunicationsForSubscriptionSupportTicket.json
        List web communications for a subscription support ticket:
          $ref: ./examples/ListWebCommunicationsForSubscriptionSupportTicket.json
        List web communication created on or after a specific date for a subscription support ticket:
          $ref: ./examples/ListWebCommunicationsForSubscriptionSupportTicketCreatedOnOrAfter.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname Communications
  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications:
    get:
      tags:
      - Communications
      description: Lists all communications (attachments not included) for a support ticket.  You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.
      operationId: microsoftAzureSupportticketcommunicationsnosubscriptionList
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name
        required: true
        type: string
      - name: $top
        in: query
        description: The number of values to return in the collection. Default is 10 and max is 10.
        required: false
        type: integer
        format: int32
      - name: $filter
        in: query
        required: false
        type: string
        description: The filter to apply on the operation. You can filter by communicationType and createdDate properties. CommunicationType supports Equals ('eq') operator and createdDate supports Greater Than ('gt') and Greater Than or Equals ('ge') operators. You may combine the CommunicationType and CreatedDate filters by Logical And ('and') operator.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved communications for a support ticket.
          schema:
            $ref: '#/definitions/CommunicationsListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        List communications for a no-subscription support ticket:
          $ref: ./examples/ListCommunicationsForSupportTicket.json
        List web communications for a no-subscription support ticket:
          $ref: ./examples/ListWebCommunicationsForSupportTicket.json
        List web communication created on or after a specific date for a no-subscription support ticket:
          $ref: ./examples/ListWebCommunicationsForSupportTicketCreatedOnOrAfter.json
      summary: Microsoft Azure Get Providers Microsoft Support Supporttickets Supportticketname Communications
  ? /subscriptions/{subscriptionId}/providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}
  : get:
      tags:
      - Communications
      description: Returns communication details for a support ticket.
      operationId: microsoftAzureCommunicationsGet
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: communicationName
        in: path
        description: Communication name.
        required: true
        type: string
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved communication details.
          schema:
            $ref: '#/definitions/CommunicationDetails'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get communication details for a subscription support ticket:
          $ref: ./examples/GetCommunicationDetailsForSubscriptionSupportTicket.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname Communications Communicationname
    put:
      tags:
      - Communications
      description: Adds a new customer communication to an Azure support ticket.
      operationId: microsoftAzureCommunicationsCreate
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: communicationName
        in: path
        description: Communication name.
        required: true
        type: string
      - name: createCommunicationParameters
        in: body
        description: Communication object.
        required: true
        schema:
          $ref: '#/definitions/CommunicationDetails'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Communication created successfully.
          schema:
            $ref: '#/definitions/CommunicationDetails'
        '202':
          description: Accepted - Communication will be created asynchronously.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        AddCommunicationToSubscriptionTicket:
          $ref: ./examples/CreateSupportTicketCommunication.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Providers Microsoft Support Supporttickets Supportticketname Communications Communicationname
  /providers/Microsoft.Support/supportTickets/{supportTicketName}/communications/{communicationName}:
    get:
      tags:
      - Communications
      description: Returns communication details for a support ticket.
      operationId: microsoftAzureCommunicationsnosubscriptionGet
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: communicationName
        in: path
        description: Communication name.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved communication details.
          schema:
            $ref: '#/definitions/CommunicationDetails'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get communication details for a no-subscription support ticket:
          $ref: ./examples/GetCommunicationDetailsForSupportTicket.json
      summary: Microsoft Azure Get Providers Microsoft Support Supporttickets Supportticketname Communications Communicationname
    put:
      tags:
      - Communications
      description: Adds a new customer communication to an Azure support ticket.
      operationId: microsoftAzureCommunicationsnosubscriptionCreate
      parameters:
      - name: supportTicketName
        in: path
        description: Support ticket name.
        required: true
        type: string
      - name: communicationName
        in: path
        description: Communication name.
        required: true
        type: string
      - name: createCommunicationParameters
        in: body
        description: Communication object.
        required: true
        schema:
          $ref: '#/definitions/CommunicationDetails'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK - Communication created successfully.
          schema:
            $ref: '#/definitions/CommunicationDetails'
        '202':
          description: Accepted - Communication will be created asynchronously.
          headers:
            Location:
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-examples:
        AddCommunicationToNoSubscriptionTicket:
          $ref: ./examples/CreateNoSubscriptionSupportTicketCommunication.json
      summary: Microsoft Azure Put Providers Microsoft Support Supporttickets Supportticketname Communications Communicationname
definitions:
  CheckNameAvailabilityInput:
    description: Input of CheckNameAvailability API.
    type: object
    required:
    - name
    - type
    properties:
      name:
        description: The resource name to validate.
        type: string
      type:
        type: string
        enum:
        - Microsoft.Support/supportTickets
        - Microsoft.Support/communications
        x-ms-enum:
          name: Type
          modelAsString: false
        description: The type of resource.
  CommunicationDetailsProperties:
    description: Describes the properties of a communication resource.
    required:
    - subject
    - body
    type: object
    properties:
      communicationType:
        description: Communication type.
        enum:
        - web
        - phone
        type: string
        x-ms-enum:
          name: CommunicationType
          modelAsString: true
        readOnly: true
      communicationDirection:
        description: Direction of communication.
        enum:
        - inbound
        - outbound
        type: string
        x-ms-enum:
          name: CommunicationDirection
          modelAsString: true
        readOnly: true
      sender:
        description: Email address of the sender. This property is required if called by a service principal.
        type: string
      subject:
        description: Subject of the communication.
        type: string
      body:
        description: Body of the communication.
        type: string
      createdDate:
        format: date-time
        description: Time in UTC (ISO 8601 format) when the communication was created.
        type: string
        readOnly: true
  CommunicationDetails:
    x-ms-azure-resource: true
    description: Object that represents a Communication resource.
    type: object
    properties:
      id:
        description: Id of the resource.
        type: string
        readOnly: true
      name:
        description: Name of the resource.
        type: string
        readOnly: true
      type:
        description: Type of the resource 'Microsoft.Support/communications'.
        type: string
        readOnly: true
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/CommunicationDetailsProperties'
        description: Properties of the resource.
  CheckNameAvailabilityOutput:
    description: Output of check name availability API.
    type: object
    properties:
      nameAvailable:
        description: Indicates whether the name is available.
        readOnly: true
        type: boolean
      reason:
        description: The reason why the name is not available.
        readOnly: true
        type: string
      message:
        description: The detailed error message describing why the name is not available.
        readOnly: true
        type: string
  CommunicationsListResult:
    description: Collection of Communication resources.
    type: object
    properties:
      value:
        description: List of Communication resources.
        type: array
        items:
          $ref: '#/definitions/CommunicationDetails'
      nextLink:
        description: The URI to fetch the next page of Communication resources.
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: API version.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: Azure subscription Id.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'