Alianza Business Line API

openapi: 3.2.0
info:
  title: Alianza Business Line API
  version: '2'
  description: 'Operations tagged Business Line across 2 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.d2.alianza.com
  description: Development
- url: https://api.q2.alianza.com
  description: QA
- url: https://api.b2.alianza.com
  description: Beta
- url: https://api.alianza.com
  description: Production
tags:
- name: Business Line
paths:
  /v2/partition/{partitionId}/account/{accountId}/business-line:
    get:
      tags:
      - Business Line
      summary: Retrieve business line list
      description: Use to retrieve a list of business lines associated to an account
      operationId: retrieveBusinessLines
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: BusinessLine
              $ref: '#/components/schemas/BusinessLine'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: BusinessLine
                  $ref: '#/components/schemas/BusinessLine'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: BusinessLine
              $ref: '#/components/schemas/BusinessLine'
          schema:
            type: array
            items:
              originalRef: BusinessLine
              $ref: '#/components/schemas/BusinessLine'
    post:
      tags:
      - Business Line
      summary: Create a new business line
      description: Use to create a new business line on an account. This includes the physical device specifications, call handling rules, and SIP credentials.
      operationId: createBusinessLine
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          content:
            application/json:
              schema:
                originalRef: BusinessLine
                $ref: '#/components/schemas/BusinessLine'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          schema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: BusinessLine
              $ref: '#/components/schemas/BusinessLine'
        description: Business line object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/business-line/views/expanded:
    get:
      tags:
      - Business Line
      summary: Retrieve business line list with lines in expanded view format
      description: Use to retrieve a list of business lines in expanded view format which is associated to an account
      operationId: retrieveBusinessLinesExpanded
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: BusinessLineExpandedView
              $ref: '#/components/schemas/BusinessLineExpandedView_2'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: BusinessLineExpandedView
                  $ref: '#/components/schemas/BusinessLineExpandedView_2'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: BusinessLineExpandedView
              $ref: '#/components/schemas/BusinessLineExpandedView_2'
          schema:
            type: array
            items:
              originalRef: BusinessLineExpandedView
              $ref: '#/components/schemas/BusinessLineExpandedView_2'
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/call-handling:
    get:
      tags:
      - Business Line
      summary: Retrieve business line call handling
      description: Use to get the call handling specifications for a business line
      operationId: getBusinessLineCallHandling
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
          content:
            application/json:
              schema:
                originalRef: CallHandling
                $ref: '#/components/schemas/CallHandling_2'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
          schema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
    put:
      tags:
      - Business Line
      summary: Update business line call handling
      description: Use to update the call handling specifications for a business line
      operationId: putBusinessLineCallHandling
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
          content:
            application/json:
              schema:
                originalRef: CallHandling
                $ref: '#/components/schemas/CallHandling_2'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
          schema:
            originalRef: CallHandling
            $ref: '#/components/schemas/CallHandling_2'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: CallHandling
              $ref: '#/components/schemas/CallHandling_2'
        description: Business line call handling object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}:
    get:
      tags:
      - Business Line
      summary: Retrieve business line
      description: Use to retrieve a business line
      operationId: retrieveBusinessLine
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          content:
            application/json:
              schema:
                originalRef: BusinessLine
                $ref: '#/components/schemas/BusinessLine'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          schema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
    put:
      tags:
      - Business Line
      summary: Update business line
      description: Use to update a business line
      operationId: updateBusinessLine
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          content:
            application/json:
              schema:
                originalRef: BusinessLine
                $ref: '#/components/schemas/BusinessLine'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
          schema:
            originalRef: BusinessLine
            $ref: '#/components/schemas/BusinessLine'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: BusinessLine
              $ref: '#/components/schemas/BusinessLine'
        description: Business line object
        required: true
    delete:
      tags:
      - Business Line
      summary: Delete business line
      description: Use to delete a business line
      operationId: deleteBusinessLine
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/views/expanded:
    get:
      tags:
      - Business Line
      summary: Retrieve business line in expanded view format
      description: Use to retrieve a business line in expanded view format
      operationId: retrieveBusinessLineExpanded
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLineExpandedView
            $ref: '#/components/schemas/BusinessLineExpandedView_2'
          content:
            application/json:
              schema:
                originalRef: BusinessLineExpandedView
                $ref: '#/components/schemas/BusinessLineExpandedView_2'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: BusinessLineExpandedView
            $ref: '#/components/schemas/BusinessLineExpandedView_2'
          schema:
            originalRef: BusinessLineExpandedView
            $ref: '#/components/schemas/BusinessLineExpandedView_2'
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/registration:
    get:
      tags:
      - Business Line
      summary: Retrieve registration status for business line
      description: Use to retrieve registration status of business line
      operationId: businessLineRegistrationStatus
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: RegistrationStatus
            $ref: '#/components/schemas/RegistrationStatus'
          content:
            application/json:
              schema:
                originalRef: RegistrationStatus
                $ref: '#/components/schemas/RegistrationStatus'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: RegistrationStatus
            $ref: '#/components/schemas/RegistrationStatus'
          schema:
            originalRef: RegistrationStatus
            $ref: '#/components/schemas/RegistrationStatus'
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment/rpc/swap:
    post:
      tags:
      - Business Line
      summary: Swap business line port assignment(s)
      description: Use to swap out the port assignments related to an existing port assignment mac address or id
      operationId: swapBusinessLinePortAssignment
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          content:
            application/json:
              schema:
                originalRef: PortAssignment
                $ref: '#/components/schemas/PortAssignment'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          schema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: DeviceSwap
              $ref: '#/components/schemas/DeviceSwap'
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment:
    get:
      tags:
      - Business Line
      summary: Retrieve business line port assignment
      description: Use to get the physical port assignment specifications for a business line
      operationId: getBusinessLinePortAssignment
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          content:
            application/json:
              schema:
                originalRef: PortAssignment
                $ref: '#/components/schemas/PortAssignment'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          schema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
    post:
      tags:
      - Business Line
      summary: Create business line port assignment
      description: Use to create the physical port assignment specifications for a business line
      operationId: createBusinessLinePortAssignment
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          content:
            application/json:
              schema:
                originalRef: PortAssignment
                $ref: '#/components/schemas/PortAssignment'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          schema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: PortAssignment
              $ref: '#/components/schemas/PortAssignment'
        description: Business line port assignment object
        required: true
    put:
      tags:
      - Business Line
      summary: Update business line port assignment
      description: Use to update the physical port assignment specifications for a business line
      operationId: updateBusinessLinePortAssignment
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          content:
            application/json:
              schema:
                originalRef: PortAssignment
                $ref: '#/components/schemas/PortAssignment'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          schema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: PortAssignment
              $ref: '#/components/schemas/PortAssignment'
        description: Business line port assignment object
        required: true
    delete:
      tags:
      - Business Line
      summary: Delete business line port assignment
      description: Use to delete the physical port assignment specifications for a business line
      operationId: deleteBusinessLinePortAssignment
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/port-assignment/push-provisioning-logs:
    get:
      tags:
      - Business Line
      summary: Retrieve provisioning logs from third party notifications
      description: Used for port assignments utilizing a mac address. Pull logs from push provisioning
      operationId: getPushProvisioningLogs
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          content:
            application/json:
              schema:
                originalRef: PortAssignment
                $ref: '#/components/schemas/PortAssignment'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
          schema:
            originalRef: PortAssignment
            $ref: '#/components/schemas/PortAssignment'
  /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/sip-credentials:
    get:
      tags:
      - Business Line
      summary: Retrieve SIP credentials
      description: Use to retrieve SIP credentials for a business line
      operationId: getBusinessLineSipCredentials
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
          content:
            application/json:
              schema:
                originalRef: SipCredentialsView
                $ref: '#/components/schemas/SipCredentialsView'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
          schema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
    put:
      tags:
      - Business Line
      summary: Update SIP credentials
      description: Use to update SIP credentials for a business line
      operationId: putBusinessLineSipCredentials
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
          content:
            application/json:
              schema:
                originalRef: SipCredentialsView
                $ref: '#/components/schemas/SipCredentialsView'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
          schema:
            originalRef: SipCredentialsView
            $ref: '#/components/schemas/SipCredentialsView'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: SipCredentials
              $ref: '#/components/schemas/SipCredentials'
        description: SIP Credentials object
        required: true
  ? /v2/partition/{partitionId}/account/{accountId}/business-line/{businessLineId}/sip-credentials/username-availability-check/{username}
  : get:
      tags:
      - Business Line
      summary: SIP Username Availability Check
      description: Use to determine if a SIP username is available to use
      operationId: isUsernameAvailable
      parameters:
      - name: businessLineId
        in: path
        description: ID of Business Line
        required: true
        schema:
          type: string
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      - name: username
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: boolean
          content:
            application/json:
              schema:
                type: boolean
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: boolean
          schema:
            type: boolean
  /v2/partition/{partitionId}/account/{accountId}/business-line/voicemail-box:
    get:
      tags:
      - Business Line
      summary: Retrieve all business line voicemail boxes on this account
      description: Use to retrieve a business line voicemail boxes on the specified account
      operationId: retrieveBusinessLineVoicemailBoxes
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: object
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              type: object
          schema:
            type: array
            items:
              type: object
    post:
      tags:
      - Business Line
      summary: Create business line voicemail box on account
      description: Use to create a business line voicemail box on the specified account
      operationId: createBusinessLineVoicemailBox
      parameters:
      - name: X-AUTH-TOKEN
        in: header
        required: false
        schema:
          type: string
      - name: partitionId
        in: path
        description: ID of partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: VoicemailBox
            $ref: '#/components/schemas/VoicemailBox'
          content:
            application/json:
              schema:
                originalRef: VoicemailBox
                $ref: '#/components/schemas/VoicemailBox'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: VoicemailBox
         

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/openapi/alianza-business-line-api-openapi.yml