Alianza

Alianza SIP Trunk Group API

Operations for managing SIP trunk groups

Documentation GitHub OpenAPI

Operations 7

GET /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup Retrieve the groups on the account #

POST /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup Create a new SIP trunk group #

DELETE /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId} Delete a SIP trunk group #

GET /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId} Retrieve a DIP trunk group #

PUT /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId} Update a SIP trunk group #

GET /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId}/forward Retrieves the forwarding rules #

PUT /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId}/forward Updates the forwarding rules #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/alianza/openapi/alianza-sip-trunk-group-api-openapi.yml

Other Resources

🔗

Swagger

https://artifacts.apis.io/alianza/openapi/_original/alianza-apidocs-swagger2-original.json

🔗

ToolCrosswalk

https://artifacts.apis.io/alianza/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:alianza-sip-trunk-group-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: Alianza Public SIP Trunk Group API
  version: '2'
  description: Welcome to the Alianza Public API documentation, based on the OpenAPI 3.0 specification.
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
security:
- X-Auth-Token: []
tags:
- name: SIP Trunk Group
  description: Operations for managing SIP trunk groups
paths:
  /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup:
    get:
      tags:
      - SIP Trunk Group
      summary: Retrieve the groups on the account
      description: Use to retrieve the SIP trunk groups created for the specified account ID and partition ID
      operationId: listGroups
      parameters:
      - name: partitionId
        in: path
        description: ID of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of the account
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SipTrunkGroup'
        4XX:
          description: Bad request
    post:
      tags:
      - SIP Trunk Group
      summary: Create a new SIP trunk group
      description: Use to create a new SIP trunk group for the specified account ID and partition ID
      operationId: createGroup
      parameters:
      - name: partitionId
        in: path
        description: ID of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: ID of the account
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipTrunkGroup'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkGroup'
        '400':
          description: Bad Request
      x-codegen-request-body-name: body
  /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId}:
    delete:
      tags:
      - SIP Trunk Group
      summary: Delete a SIP trunk group
      description: Use to delete the SIP trunk group for the specified account ID, partition ID and group ID
      operationId: deleteGroup
      parameters:
      - name: partitionId
        in: path
        description: id of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: id of the account
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: id group
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation
        '404':
          description: Not Found
    get:
      tags:
      - SIP Trunk Group
      summary: Retrieve a DIP trunk group
      description: Use to retrieve the SIP trunk group for the specified account ID, partition ID and group ID
      operationId: getGroup
      parameters:
      - name: partitionId
        in: path
        description: id of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: id of the account
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: id group
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkGroup'
        '404':
          description: Not found
    put:
      tags:
      - SIP Trunk Group
      summary: Update a SIP trunk group
      description: Use to update a SIP trunk group created for the specified account ID, partition ID and group ID
      operationId: updateGroup
      parameters:
      - name: partitionId
        in: path
        description: id of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: id of the account
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: id group
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipTrunkGroup'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkGroup'
        '400':
          description: Bad Request
        '404':
          description: Not Found
      x-codegen-request-body-name: body
  /v2/partition/{partitionId}/account/{accountId}/siptrunkgroup/{groupId}/forward:
    get:
      tags:
      - SIP Trunk Group
      summary: Retrieves the forwarding rules
      description: Use to retrieve the SIP trunk group forwarding rules for the specified account ID, partition ID and group ID
      operationId: getFailover
      parameters:
      - name: partitionId
        in: path
        description: id of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: id of the account
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: id group
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkGroupForwardRules'
        '404':
          description: Not found
    put:
      tags:
      - SIP Trunk Group
      summary: Updates the forwarding rules
      description: Use to update the SIP trunk group forwarding rules created for the specified account ID, partition ID and group ID
      operationId: updateFailover
      parameters:
      - name: partitionId
        in: path
        description: id of the partition
        required: true
        schema:
          type: string
      - name: accountId
        in: path
        description: id of the account
        required: true
        schema:
          type: string
      - name: groupId
        in: path
        description: id group
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkGroupForwardRules'
        '404':
          description: Not found
components:
  schemas:
    SipTrunkForwardAlwaysReference:
      allOf:
      - $ref: '#/components/schemas/SipTrunkForwardReference'
      - type: object
        properties:
          enabled:
            type: boolean
    ReferenceType:
      type: string
      enum:
      - SIP_TRUNK
      - END_USER
      - TELEPHONE
      - AUTO_ATTENDANT
      - IVR
      - VOICEMAIL
      - BUSY
    SipTrunkForwardReference:
      type: object
      required:
      - referenceType
      properties:
        referenceId:
          type: string
          description: id of the entity to forward the calls to
        referenceType:
          $ref: '#/components/schemas/ReferenceType'
    SipTrunkGroup:
      type: object
      required:
      - name
      properties:
        id:
          type: string
        name:
          type: string
          description: name of the group
        partitionId:
          type: string
        accountId:
          type: string
        unconditionalForward:
          $ref: '#/components/schemas/SipTrunkForwardAlwaysReference'
        unreachableForward:
          type: array
          items:
            $ref: '#/components/schemas/SipTrunkForwardReference'
        capacityForward:
          type: array
          items:
            $ref: '#/components/schemas/SipTrunkForwardReference'
        sipTrunksIds:
          type: array
          items:
            type: string
    SipTrunkGroupForwardRules:
      type: object
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        sipTrunkGroupId:
          type: string
        unconditionalForward:
          $ref: '#/components/schemas/SipTrunkForwardAlwaysReference'
        unreachableForward:
          type: array
          items:
            $ref: '#/components/schemas/SipTrunkForwardReference'
        capacityForward:
          type: array
          items:
            $ref: '#/components/schemas/SipTrunkForwardReference'
  securitySchemes:
    X-Auth-Token:
      type: apiKey
      in: header
      name: X-AUTH-TOKEN
x-provenance:
  method: harvested
  publisher: Alianza
  source: https://developer.alianza.com/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)