CM.com · Schema

Phone Number Config Sip

Configuration settings for configuring a Phone Number for SIP trunking.

CompanyCPaaSMessagingSMSVoicePaymentsVerificationTicketing

Properties

Name Type Description
type string The Application type that should be used. Can be either `directforwarding`, `flowbuilder`, `notification`, `sip`, `halo` or `none`.
phoneNumber integer The Phone Number that the current configuration applies to.
distributionGroupGuid string Unique identifier of the Distribution Group.
algorithm stringnull The algorithm for the distribution group that should be applied, can be either `RoundRobin` or `FailOver`.
fallbackDistributionGroupGuid stringnull Unique identifier of the fallback Distribution Group.
fallbackAlgorithm stringnull The algorithm for the fallback Distribution Group that should be applied, can be either `RoundRobin` or `FailOver`.
View JSON Schema on GitHub

JSON Schema

cm-com-api-phone-number-config-sip-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/cm-com/main/json-schema/cm-com-api-phone-number-config-sip-schema.json",
  "title": "Phone Number Config Sip",
  "description": "Configuration settings for configuring a Phone Number for SIP trunking.",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cm-com-voice-phone-numbers-v1-openapi.yml#/components/schemas/ApiPhoneNumberConfigSip",
  "type": "object",
  "allOf": [
    {
      "$ref": "#/$defs/ApiPhoneNumberConfig"
    }
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "The Application type that should be used. Can be either `directforwarding`, `flowbuilder`, `notification`, `sip`, `halo` or `none`."
    },
    "distributionGroupGuid": {
      "type": "string",
      "description": "Unique identifier of the Distribution Group.",
      "format": "uuid"
    },
    "algorithm": {
      "type": [
        "string",
        "null"
      ],
      "description": "The algorithm for the distribution group that should be applied, can be either `RoundRobin` or `FailOver`."
    },
    "fallbackDistributionGroupGuid": {
      "type": [
        "string",
        "null"
      ],
      "description": "Unique identifier of the fallback Distribution Group.",
      "format": "uuid"
    },
    "fallbackAlgorithm": {
      "type": [
        "string",
        "null"
      ],
      "description": "The algorithm for the fallback Distribution Group that should be applied, can be either `RoundRobin` or `FailOver`."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ApiPhoneNumberConfig": {
      "title": "Phone Number Config",
      "type": "object",
      "properties": {
        "type": {
          "type": [
            "string",
            "null"
          ],
          "description": "The Application type that should be used. Can be either `directforwarding`, `flowbuilder`, `notification`, `sip`, `halo` or `none`.",
          "readOnly": true
        },
        "phoneNumber": {
          "type": "integer",
          "description": "The Phone Number that the current configuration applies to.",
          "format": "int64"
        }
      },
      "additionalProperties": false,
      "description": "Model that represents the config of a phone number"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/cm-com-api-phone-number-config-sip"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

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