Avaya Avaya Cloud Office management API

openapi: 3.2.0
info:
  title: Admin - Voice Avaya Cloud Office management API
  description: 'The Voice provider APIs are used to manage information about voice specific elements and different voice related entities e.g. Phone numbers.


    Voice Services will support multiple ways to provision voice providers

    1. Programmatic Interface (Rest APIs)

    2. User Interface'
  contact:
    name: Avaya API Team
    url: https://developers.avayacloud.com/onecloud-ccaas
    email: apiteam@avaya.com
  license:
    name: Avaya Software Development Kit (SDK) Software License Terms
    url: http://support.avaya.com/css/P8/documents/101038288
  version: 1.0.2
servers:
- url: '{protocol}://{server}{basePath}'
  description: Open API
  variables:
    protocol:
      enum:
      - https
      default: https
    server:
      default: HOST-REGION.api.avayacloud.com
    basePath:
      default: /api/admin/voice/v1
security:
- {}
- BearerAuth: []
  AppKey: []
tags:
- name: Avaya Cloud Office management
  description: APIs to manage Avaya Cloud Office element in voice service
paths:
  /accounts/{accountId}/aco-elements:
    post:
      tags:
      - Avaya Cloud Office management
      summary: Create Avaya Cloud Office
      description: '**This API requires the Account Administrator role.**


        Add a new Avaya Cloud Office element with required ACO Server data.


        Only one instance of Avaya Cloud Office element can be created for an account.


        The following field must be unique otherwise a `HTTP 409 Conflict` will be returned:

        * `name`


        Will trigger asynchronous updates, the status of which should be monitored via `GET /aco-elements/{elementId}`.'
      operationId: createAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        description: Avaya Cloud Office
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACOElement'
            examples:
              ACO:
                $ref: '#/components/examples/ACORequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorACOExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/aco-elements/{elementId}:
    put:
      tags:
      - Avaya Cloud Office management
      summary: Update Avaya Cloud Office
      description: '**This API requires the Account Administrator role.**


        Update an existing Avaya Cloud Office element by unique element Id and ACO server details.


        Will trigger asynchronous updates, the status of which should be monitored via `GET /aco-elements/{elementId}`.'
      operationId: updateAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACOElement'
            examples:
              ACO:
                $ref: '#/components/examples/ACORequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorACOExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Cloud Office management
      summary: Get Avaya Cloud Office
      description: '**This API requires the Account Administrator role.**


        Get an existing Avaya Cloud Office element by unique element Id'
      operationId: getAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Avaya Cloud Office management
      summary: Delete Avaya Cloud Office
      description: '**This API requires the Account Administrator role.**


        Delete an existing Avaya Cloud Office instance by unique element Id'
      operationId: deleteAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    ErrorConstraintViolation:
      description: Constraint Violation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConstraintViolation'
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    ErrorACOExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            loginId:
              $ref: '#/components/examples/ErrorACOExists'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
  examples:
    ErrorNotFound:
      description: Not Found
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
        title: Resource Not Found
        status: 404
        detail: Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found.
    ErrorForbidden:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
        title: Forbidden
        status: 403
        detail: According to the access control policy the current user does not have permission to access this resource.
    ErrorUnauthorized:
      description: Unauthorized
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
        title: Unauthorized
        status: 401
        detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
    ErrorACOExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: An Avaya Cloud Office with this name already exists
    ACORequest:
      value:
        name: Avaya Cloud Office
        environment: Production
        description: Avaya Cloud Office Description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        isChatEnabled: true
        isExtensionCalling: false
        presenceApplicationType: AVAYA_CLOUD_OFFICE
    ErrorConstraintViolation:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title: Constraint Violation
        status: 400
        detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.
        violations:
        - field: accountId
          message: must match "^[a-zA-Z]{6}$"
          code: 20006
    ErrorInternalServerError:
      description: Server Error
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
        title: Server Error
        status: 500
        detail: An internal server error was encountered.
    ACOResponse:
      value:
        elementId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        name: Avaya Cloud Office
        environment: Production
        description: Avaya Cloud Office Description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        isChatEnabled: true
        isExtensionCalling: false
        elementType: ACO
        status: SUCCESS
        presenceApplicationType: AVAYA_CLOUD_OFFICE
  parameters:
    accountId:
      name: accountId
      description: The unique 6 character internal id that represents the customer account.
      required: true
      in: path
      schema:
        type: string
        minLength: 6
        maxLength: 6
        pattern: ^[a-zA-Z]{6}$
        example: ABCDEF
    elementId:
      name: elementId
      in: path
      description: The unique 36 character internal id (uuid) that represents the Element.
      required: true
      schema:
        type: string
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        minLength: 36
        maxLength: 36
        pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
  schemas:
    ACOElement:
      type: object
      description: 'Avaya Cloud Office Element Details

        '
      properties:
        elementId:
          type: string
          readOnly: true
          example: ce8042a2-12f8-406f-5fd3-86c1c16d3a77
        name:
          type: string
          example: Avaya Cloud Office
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        environment:
          type: string
          enum:
          - Production
          - Development
          example: Production
        description:
          type: string
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ ]+$)
        didNumbers:
          description: The did numbers in the E.164 format
          type: array
          maxItems: 2000
          items:
            type: string
            maxLength: 13
          example:
          - '+16062128688'
          - '+12702289911'
        isChatEnabled:
          type: boolean
          description: Indicates whether the chat is enabled for any given ACO element.
          default: true
          example: true
        isExtensionCalling:
          type: boolean
          description: Indicates whether the extension calling is disabled for any given ACO element.
          default: false
          example: false
        elementType:
          type: string
          readOnly: true
          example: ACO
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\_\.\ ]+$
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - operation on Element was failed.\n  * IN_PROGRESS - operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
        presenceApplicationType:
          type: string
          enum:
          - AVAYA_CLOUD_OFFICE
          - AVAYA_CLOUD_PHONE
          x-enum-varnames:
          - AVAYA_CLOUD_OFFICE
          - AVAYA_CLOUD_PHONE
      required:
      - name
      - environment
    Problem:
      type: object
      description: '<b>Problem Detail</b> as a way to carry machine-readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).

            '
          default: about:blank
          example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title:
          type:
          - string
          - 'null'
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized).

            '
          example: Service Unavailable
        status:
          type:
          - integer
          - 'null'
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          example: 503
          exclusiveMaximum: 600
        detail:
          type:
          - string
          - 'null'
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
        instance:
          type:
          - string
          - 'null'
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

            '
        violations:
          type:
          - array
          - 'null'
          description: 'A list of violations that occurred as a result of invalid data provided as part of a request.

            '
          items:
            type: object
            properties:
              field:
                type: string
                description: 'The name of the field in the request that caused the violation. This can be the name of a path parameter, query parameter, or a field within the request body.

                  '
                example: accountId
              message:
                type: string
                description: 'A human readable explanation specific to this occurrence of the violation.

                  '
                example: must match "^[a-zA-Z]{6}$"
              code:
                type: integer
                format: int32
                description: 'The violation code generated by the server for this occurrence of the violation. Use this code when implementing any error handling logic instead of the message, as the message can change.

                  '
                example: 20006
          example:
          - field: emailAddress
            message: must not be null
            code: 20002
          - field: accountId
            message: must match "^[a-zA-Z]{6}$"
            code: 20006
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: This API uses Bearer Token Authorization Flow
      bearerFormat: JWT
    AppKey:
      type: apiKey
      in: header
      name: appkey
      description: This API needs an appKey as header
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go