Webex · Schema

PutTelephonyLocationObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
announcementLanguage	string	Location's phone announcement language.
callingLineId	object	Location calling line information.
connection	object	Connection details can only be modified to and from local PSTN types of `TRUNK` and `ROUTE_GROUP`.
externalCallerIdName	string	External caller ID name value. Unicode characters.
pAccessNetworkInfo	string	Emergency Location Identifier for a location. The `pAccessNetworkInfo` is set only when the location's country is Belgium(`BE`), Germany(`DE`), or France(`FR`).
outsideDialDigit	string	Must dial to reach an outside line. Default is none.
enforceOutsideDialDigit	boolean	True when enforcing outside dial digit at location level to make PSTN calls.
routingPrefix	string	Must dial a prefix when calling between locations having same extension within same location, should be numeric.
chargeNumber	string	Set the chargeable number for the line placing the call. When set and [useChargeNumberForPChargeInfo field (GET location)](/docs/api/v1/beta-location-call-settings-with-p-charge-info-support/get-locat

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutTelephonyLocationObject",
  "title": "PutTelephonyLocationObject",
  "type": "object",
  "properties": {
    "announcementLanguage": {
      "type": "string",
      "example": "fr_fr",
      "description": "Location's phone announcement language."
    },
    "callingLineId": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Denver Incoming",
          "description": "Group calling line ID name. By default the org name."
        },
        "phoneNumber": {
          "type": "string",
          "example": "+12145555698",
          "description": "Directory Number / Main number in E.164 Format."
        }
      },
      "description": "Location calling line information."
    },
    "connection": {
      "type": "object",
      "properties": {
        "type": {
          "$ref": "#/components/schemas/RouteType",
          "description": "Webex Calling location API only supports setting `TRUNK` or `ROUTE_GROUP`."
        },
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ",
          "description": "A unique identifier of route type."
        }
      },
      "description": "Connection details can only be modified to and from local PSTN types of `TRUNK` and `ROUTE_GROUP`."
    },
    "externalCallerIdName": {
      "type": "string",
      "example": "Big Corp-Denve",
      "description": "External caller ID name value. Unicode characters."
    },
    "pAccessNetworkInfo": {
      "type": "string",
      "example": "Richardson-TX",
      "description": "Emergency Location Identifier for a location. The `pAccessNetworkInfo` is set only when the location's country is Belgium(`BE`), Germany(`DE`), or France(`FR`)."
    },
    "outsideDialDigit": {
      "type": "string",
      "example": "12",
      "description": "Must dial to reach an outside line. Default is none."
    },
    "enforceOutsideDialDigit": {
      "type": "boolean",
      "example": true,
      "description": "True when enforcing outside dial digit at location level to make PSTN calls."
    },
    "routingPrefix": {
      "type": "string",
      "example": "2",
      "description": "Must dial a prefix when calling between locations having same extension within same location, should be numeric."
    },
    "chargeNumber": {
      "type": "string",
      "example": "+14158952369",
      "description": "Set the chargeable number for the line placing the call.  When set and [useChargeNumberForPChargeInfo field (GET location)](/docs/api/v1/beta-location-call-settings-with-p-charge-info-support/get-location-webex-calling-details) is true for the location, all PSTN calls placed from this location will include a P-Charge-Info header with this specified number in the SIP INVITE."
    }
  }
}