Alianza

Alianza Business Line Hunt Group API

The Business Line Hunt Group API from Alianza — 6 operation(s) for business line hunt group.

GitHub OpenAPI

Operations 13

GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group Retrieve business line hunt group list #
POST /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group Create a new business line hunt group #
GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/failover-action/{reason} Retrieve business line hunt group failover action for the specified reason #
PUT /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/failover-action/{reason} Update business line hunt group failover action for the specified reason #
GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id}/constraints/star-code Retrieve a list of available star codes to forward the hunt group #
GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration Retrieve business line hunt group forwarding configuration list #
POST /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration Create a new business line hunt group forwarding configuration #
GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id} Retrieve business line hunt group forwarding configuration #
PUT /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id} Update business line hunt group forwarding configuration #
DELETE /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id} Delete business line hunt group forwarding configuration #
GET /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId} Retrieve business line hunt group #
PUT /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId} Update business line hunt group #
DELETE /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId} Delete business line hunt group #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/openapi/alianza-business-line-hunt-group-api-openapi.yml

Other Resources

🔗
Swagger
https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/openapi/_original/alianza-apidocs-swagger2-original.json
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/alianza/refs/heads/main/mcp/alianza-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alianza-business-line-hunt-group-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alianza-business-line-hunt-group-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Alianza Business Line Hunt Group API
  version: '2'
  description: 'Operations tagged Business Line Hunt Group across 3 of this provider''s published API definitions: alianza-apidocs-swagger2-original.json, alianza-business-line-hunt-group-api-openapi.yml, 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 Hunt Group
paths:
  /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group:
    get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve business line hunt group list
      description: Use to retrieve a list of business lines hunt groups associated to an account
      operationId: retrieveBusinessLineHuntGroups
      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: HuntGroup
              $ref: '#/components/schemas/HuntGroup'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: HuntGroup
                  $ref: '#/components/schemas/HuntGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: HuntGroup
              $ref: '#/components/schemas/HuntGroup'
          schema:
            type: array
            items:
              originalRef: HuntGroup
              $ref: '#/components/schemas/HuntGroup'
    post:
      tags:
      - Business Line Hunt Group
      summary: Create a new business line hunt group
      description: Use to create a new business line hunt group on an account.
      operationId: createBusinessLineHuntGroup
      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: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          content:
            application/json:
              schema:
                originalRef: HuntGroup
                $ref: '#/components/schemas/HuntGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          schema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: HuntGroup
              $ref: '#/components/schemas/HuntGroup'
        description: Business line hunt group object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/failover-action/{reason}:
    get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve business line hunt group failover action for the specified reason
      description: Use to retrieve a failover action for a business lines hunt group
      operationId: getBusinessLineHuntGroupFailoverAction
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: reason
        in: path
        required: true
        schema:
          type: string
          enum:
          - NO_ANSWER
          - BUSY
          - UNREGISTERED
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
          content:
            application/json:
              schema:
                originalRef: FailoverAction
                $ref: '#/components/schemas/FailoverAction'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
          schema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
    put:
      tags:
      - Business Line Hunt Group
      summary: Update business line hunt group failover action for the specified reason
      description: Use to update the failvover action for a business line hunt group
      operationId: updateBusinessLineHuntGroupFailoverAction
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: reason
        in: path
        required: true
        schema:
          type: string
          enum:
          - NO_ANSWER
          - BUSY
          - UNREGISTERED
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
          content:
            application/json:
              schema:
                originalRef: FailoverAction
                $ref: '#/components/schemas/FailoverAction'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
          schema:
            originalRef: FailoverAction
            $ref: '#/components/schemas/FailoverAction'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: FailoverAction
              $ref: '#/components/schemas/FailoverAction'
        description: Business line hunt group failover action object
        required: true
  ? /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id}/constraints/star-code
  : get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve a list of available star codes to forward the hunt group
      description: Use to retrieve a list of available star codes to assign to business line hunt group including the current star code assigned to this hunt group's forwarding configuration. Use '*' to search without a forward configuration id
      operationId: getAvailableStarCodes
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PartitionStarCodes
            $ref: '#/components/schemas/PartitionStarCodes'
          content:
            application/json:
              schema:
                originalRef: PartitionStarCodes
                $ref: '#/components/schemas/PartitionStarCodes'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: PartitionStarCodes
            $ref: '#/components/schemas/PartitionStarCodes'
          schema:
            originalRef: PartitionStarCodes
            $ref: '#/components/schemas/PartitionStarCodes'
  /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration:
    get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve business line hunt group forwarding configuration list
      description: Use to retrieve a list of forwarding configurations on a business lines hunt group
      operationId: getBusinessLineHuntGroupForwardingConfigurations
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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:
            type: array
            items:
              originalRef: ForwardConfiguration
              $ref: '#/components/schemas/ForwardConfiguration'
          content:
            application/json:
              schema:
                type: array
                items:
                  originalRef: ForwardConfiguration
                  $ref: '#/components/schemas/ForwardConfiguration'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            type: array
            items:
              originalRef: ForwardConfiguration
              $ref: '#/components/schemas/ForwardConfiguration'
          schema:
            type: array
            items:
              originalRef: ForwardConfiguration
              $ref: '#/components/schemas/ForwardConfiguration'
    post:
      tags:
      - Business Line Hunt Group
      summary: Create a new business line hunt group forwarding configuration
      description: Use to create a new forwarding configuration on a business line hunt group.
      operationId: createBusinessLineHuntGroupForwardingConfiguration
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          content:
            application/json:
              schema:
                originalRef: ForwardConfiguration
                $ref: '#/components/schemas/ForwardConfiguration'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          schema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: ForwardConfiguration
              $ref: '#/components/schemas/ForwardConfiguration'
        description: Business line hunt group forwarding configuration object
        required: true
  /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}/forward-configuration/{id}:
    get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve business line hunt group forwarding configuration
      description: Use to get the forwarding configuration for a business line hunt group
      operationId: getBusinessLineHuntGroupForwardingConfiguration
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          content:
            application/json:
              schema:
                originalRef: ForwardConfiguration
                $ref: '#/components/schemas/ForwardConfiguration'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          schema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
    put:
      tags:
      - Business Line Hunt Group
      summary: Update business line hunt group forwarding configuration
      description: Use to update the forwarding configuration for a business line hunt group
      operationId: updateBusinessLineHuntGroupForwardingConfiguration
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: successful operation
          responseSchema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          content:
            application/json:
              schema:
                originalRef: ForwardConfiguration
                $ref: '#/components/schemas/ForwardConfiguration'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
          schema:
            originalRef: ForwardConfiguration
            $ref: '#/components/schemas/ForwardConfiguration'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: ForwardConfiguration
              $ref: '#/components/schemas/ForwardConfiguration'
        description: Business line hunt group forwarding configuration object
        required: true
    delete:
      tags:
      - Business Line Hunt Group
      summary: Delete business line hunt group forwarding configuration
      description: Use to delete the forwarding configuration for a business line hunt group
      operationId: deleteBusinessLineHuntGroupForwardingConfiguration
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        default:
          description: successful operation
      responsesObject:
        default:
          description: successful operation
  /v2/partition/{partitionId}/account/{accountId}/business-line-hunt-group/{huntGroupId}:
    get:
      tags:
      - Business Line Hunt Group
      summary: Retrieve business line hunt group
      description: Use to retrieve a business line hunt group
      operationId: retrieveBusinessLineHuntGroup
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          content:
            application/json:
              schema:
                originalRef: HuntGroup
                $ref: '#/components/schemas/HuntGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          schema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
    put:
      tags:
      - Business Line Hunt Group
      summary: Update business line hunt group
      description: Use to update a business line hunt group
      operationId: updateBusinessLineHuntGroup
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          content:
            application/json:
              schema:
                originalRef: HuntGroup
                $ref: '#/components/schemas/HuntGroup'
      responsesObject:
        '200':
          description: successful operation
          responseSchema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
          schema:
            originalRef: HuntGroup
            $ref: '#/components/schemas/HuntGroup'
      requestBody:
        content:
          application/json:
            schema:
              originalRef: HuntGroup
              $ref: '#/components/schemas/HuntGroup'
        description: Business line hunt group object
        required: true
    delete:
      tags:
      - Business Line Hunt Group
      summary: Delete business line hunt group
      description: Use to delete a business line hunt group
      operationId: deleteBusinessLineHuntGroup
      parameters:
      - name: huntGroupId
        in: path
        description: ID of Business Line Hunt Group
        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
components:
  schemas:
    ForwardConfiguration:
      type: object
      required:
      - forwardConfigurationType
      - forwardToPhoneNumber
      - huntGroupId
      - name
      - starCode
      properties:
        id:
          type: string
          format: uuid
        starCode:
          type: string
          pattern: \*d+
        huntGroupId:
          type: string
          format: uuid
        forwardConfigurationType:
          type: string
          enum:
          - VARIABLE
          - FIXED
        forwardToPhoneNumber:
          type: string
          pattern: \d+
        name:
          type: string
    PartitionStarCodes:
      type: object
      properties:
        constraintType:
          type: string
        constraintValue:
          type: array
          items:
            type: string
    FailoverAction:
      type: object
      required:
      - '@type'
      - failoverReason
      discriminator:
        propertyName: '@type'
      properties:
        failoverReason:
          type: string
          enum:
          - BUSY
          - NO_ANSWER
          - UNREGISTERED
        '@type':
          type: string
          enum:
          - BusyFailoverAction
          - ForwardFailoverAction
          - VoicemailFailoverAction
    HuntingConfiguration:
      type: object
      required:
      - '@type'
      discriminator:
        propertyName: '@type'
      properties:
        '@type':
          type: string
          enum:
          - LinearHuntingConfiguration
          - SequentialHuntingConfiguration
          - SimultaneousHuntingConfiguration
    HuntGroup:
      type: object
      required:
      - accountId
      - huntingConfiguration
      - name
      - partitionId
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        partitionId:
          type: string
        accountId:
          type: string
        huntingConfiguration:
          originalRef: HuntingConfiguration
          $ref: '#/components/schemas/HuntingConfiguration'
        activeForwardConfigurationId:
          type: string
          format: uuid
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-refined-from:
- alianza-apidocs-swagger2-original.json
- alianza-business-line-hunt-group-api-openapi.yml
- alianza-openapi-original.yml