Alianza

Alianza Sip Trunk Caller ID Mapping API

Operations for managing Sip Trunk Caller ID mappings

Documentation GitHub OpenAPI

Operations 8

GET /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/fromnumber Retrieve list of all Custom FROM Numbers #

POST /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/fromnumber Create a FROM Number #

DELETE /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/fromnumber/{fromNumber} Delete a FROM Number #

GET /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/mapping Retrieve list of all FROM Number to Caller ID mappings #

PUT /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/mapping Update a FROM Number to Caller ID mapping #

GET /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/callerid Retrieve list of all Caller IDs #

POST /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/callerid Create a Caller ID #

DELETE /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/callerid/{callerId} Delete a Caller ID #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/alianza/openapi/alianza-sip-trunk-caller-id-mapping-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-caller-id-mapping-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 Caller ID Mapping 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 Caller ID Mapping
  description: Operations for managing Sip Trunk Caller ID mappings
paths:
  /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/fromnumber:
    get:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Retrieve list of all Custom FROM Numbers
      description: Use to retrieve a list of all Custom FROM Numbers for the specified account ID and partition ID.
      operationId: listCustomFromNumbers
      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/FromTelephoneNumberResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    post:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Create a FROM Number
      description: Use to create a FROM Number for the specified account ID and partition ID.
      operationId: createFromNumber
      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/FromTelephoneNumberRequest'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FromTelephoneNumberResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
  /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/fromnumber/{fromNumber}:
    delete:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Delete a FROM Number
      description: Use to delete the FROM Number for the specified account ID, partition ID and FROM Number.
      operationId: deleteFromNumber
      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: fromNumber
        in: path
        description: exact FROM Telephone Number or wildcard
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
  /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/mapping:
    get:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Retrieve list of all FROM Number to Caller ID mappings
      description: Use to retrieve a list of all FROM Number to Caller ID mappings for the specified account ID and partition ID.
      operationId: listCallerIdMappings
      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/CidMappingResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    put:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Update a FROM Number to Caller ID mapping
      description: Use to update a FROM Number to Caller ID mapping by setting Custom Caller ID Number or set it to null to remove mapping for the specified account ID and partition ID.
      operationId: updateFromNumber
      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/CidMappingRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CidMappingResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
  /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/callerid:
    get:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Retrieve list of all Caller IDs
      description: Use to retrieve a list of all Caller IDs for the specified account ID and partition ID.
      operationId: listCallerIds
      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/CustomCallerIdNumberResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
    post:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Create a Caller ID
      description: Use to create a Caller ID for the specified account ID and partition ID.
      operationId: createCallerId
      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/CustomCallerIdNumberRequest'
        required: true
      responses:
        '201':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomCallerIdNumberResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
  /v2/partition/{partitionId}/account/{accountId}/siptrunk_2/cid/callerid/{callerId}:
    delete:
      tags:
      - Sip Trunk Caller ID Mapping
      summary: Delete a Caller ID
      description: Use to delete the Caller ID for the specified account ID, partition ID and Custom Caller ID Number with automatic cleanup of related mappings.
      operationId: deleteCallerId
      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: callerId
        in: path
        description: Custom Caller ID Number
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
        '403':
          description: User does not have enough permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiException'
components:
  schemas:
    FromTelephoneNumberRequest:
      type: object
      required:
      - fromWildcard
      properties:
        fromWildcard:
          type: string
    CustomCallerIdNumberRequest:
      type: object
      required:
      - customCallerIdNumber
      properties:
        customCallerIdNumber:
          type: string
    CidMappingRequest:
      type: object
      required:
      - fromWildcard
      properties:
        fromWildcard:
          type: string
        customCallerIdNumber:
          type: string
    CustomCallerIdNumberResponse:
      type: object
      required:
      - customCallerIdNumber
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        customCallerIdNumber:
          type: string
    CidMappingResponse:
      type: object
      required:
      - fromWildcard
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        fromWildcard:
          type: string
        customCallerIdNumber:
          type: string
        isCustom:
          type: boolean
    PublicApiException:
      type: object
      properties:
        status:
          type: integer
        messages:
          type: array
          items:
            type: string
        data:
          type: object
          additionalProperties: true
          example:
            key: value
            key2: value2
    FromTelephoneNumberResponse:
      type: object
      required:
      - fromWildcard
      properties:
        partitionId:
          type: string
        accountId:
          type: string
        fromWildcard:
          type: string
        isCustom:
          type: boolean
  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)