Avaya Hybrid Extension API

openapi: 3.2.0
info:
  title: Admin - Voice Hybrid Extension 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: Hybrid Extension
  description: Management of hybrid extensions assigned to users. These API are expected to be called by an account administrator.
paths:
  /accounts/{accountId}/communication-managers/{communicationManagerId}/extensions:
    get:
      tags:
      - Hybrid Extension
      summary: Get Extensions
      description: '**This API requires the Account Administrator role.**


        Get list of Extensions belongs to specific account and communication manager.'
      operationId: listExtensions
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: 'The maximum number of results per page. Default value is 10, max value is 100.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 10
          default: 10
          minimum: 1
          maximum: 100
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter. Only name and number columns are allowed.\n- Field Names are case-senstive (should be written as it is in description).\n- The allowed format begins with the column name, A string expression including the * wildcard character.\n    - :{PREFIX}* will be used to find out word start with.\n    - :*{POSTFIX} will be used to find out word end with\n    - :{string} will be used to find out word that contains given value.\n    - :{number} will be used to find out number that equal to given value.\n"
        schema:
          type: string
          maxLength: 255
        examples:
          filterByNameStartsWith:
            value: name:extension*
            summary: filter result by name starts with name value
          filterByNameEndsWith:
            value: name:*extension
            summary: filter result by name ends with name value
          filterByNameContainsToUsingColon:
            value: name:extension
            summary: 'filter result by name equals to value using : operator'
          filterByNumberEqualsToUsingColon:
            value: number:10
            summary: 'filter result by number equals to value using : operator'
      - name: orderBy
        in: query
        required: false
        description: 'Specifies details of a filter. Only name and number columns are allowed.

          - Field Names are case-senstive (should be written as it is in description).

          - The default sorting order is ascending.

          - The default order by is number.

          '
        schema:
          type: string
          maxLength: 255
        examples:
          orderByNameInDescendingOrder:
            value: name desc
            summary: sort data based on name in descending order
          orderByNameInAscendingOrder:
            value: name
            summary: sort data based on name in ascending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionPage'
              examples:
                default:
                  $ref: '#/components/examples/ExtensionPage'
        '400':
          description: Constraint violation for accountId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/extensions/{extensionId}:
    delete:
      tags:
      - Hybrid Extension
      summary: Delete Extension
      description: '**This API requires the Account Administrator role.**


        Deletes a extension by Id.'
      operationId: deleteExtension
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/extensionId'
      responses:
        '202':
          description: Accepted
        '400':
          description: Constraint violation for extensionId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  examples:
    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.
    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
    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.
    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
    ExtensionPage:
      description: 'Paginated extension response

        '
      value:
        pagination:
          pageNumber: 1
          pageSize: 10
          total: 40
        resources:
        - id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
          number: 50003456
          name: Jon Extension
          loginId:
          - user@avaya.com
        links:
          prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=2&pageSize=10
    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.
  responses:
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
  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
    extensionId:
      name: extensionId
      in: path
      description: The unique 36 character internal id for the extension
      required: true
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174000
    pageNumber:
      name: pageNumber
      in: query
      description: The page number of the records to retrieve. Default value is 1.
      required: false
      schema:
        type: integer
        format: int32
        example: 1
        default: 1
        minimum: 1
    communicationManagerId:
      name: communicationManagerId
      description: The unique id of the Communication Manager
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 2ec20580-d204-43f3-ae0b-34795439137f
  schemas:
    ExtensionPage:
      type: object
      description: Extension filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionResponse'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=2&pageSize=10
    Links:
      type: object
      properties:
        prev:
          type: string
          description: URL of the previous page. Blank if currently on the first page.
        next:
          type: string
          description: URL of the next page. Blank if currently on the last page.
    ExtensionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique Extension uuid.
          example: 1f15835f-1365-4913-acf3-0ffd0767ad6e
          readOnly: true
        number:
          type: integer
          format: int64
          description: Extension number
          example: 50003456
          minimum: 1
          maximum: 10000000000000000
        name:
          type: string
          description: Extension name
          example: Jon Extension
          maxLength: 27
        loginId:
          type: array
          items:
            type: string
            description: Extension to user id association.
            example: user@avaya.com
    Pagination:
      type: object
      properties:
        pageNumber:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The max number of records that can be retrieved on this page.
        total:
          type: integer
          description: The total number of records.
    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