Webex · Schema

GetTelephonyLocationObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the location.
name	string	The name of the location.
announcementLanguage	string	Location's phone announcement language.
callingLineId	object	Location calling line information.
connection	object	Connection details are only returned for local PSTN types of `TRUNK` or `ROUTE_GROUP`.
subscriptionId	string	PSTN connection ID given for locations with a PSTN subscription.
externalCallerIdName	string	External Caller ID Name value. Unicode characters.
userLimit	number	Limit on the number of people at the location. Read-Only.
pAccessNetworkInfo	string	Emergency Location Identifier for a location. Set this field to provide the SIP access network information to the provider which will be used to populate the SIP P-Access-Network-Info header. This is
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.
defaultDomain	string	IP Address, hostname, or domain. Read-Only.
chargeNumber	string	Chargeable number for the line placing the call. When set and useChargeNumberForPChargeInfo is true, all PSTN calls placed from this location will include a P-Charge-Info header with this specified nu
useChargeNumberForPChargeInfo	boolean	Indicates whether the location's chargeNumber (if set) is enabled for use as the P-Charge-Info header in the SIP INVITE for all PSTN calls placed from this location. The field is returned as true if t

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetTelephonyLocationObject",
  "title": "GetTelephonyLocationObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "announcementLanguage",
    "callingLineId",
    "connection",
    "externalCallerIdName",
    "userLimit",
    "outsideDialDigit",
    "routingPrefix",
    "defaultDomain"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9kR1Z6ZEZKMWJHVTA",
      "description": "A unique identifier for the location."
    },
    "name": {
      "type": "string",
      "example": "'Denver'",
      "description": "The name of the location."
    },
    "announcementLanguage": {
      "type": "string",
      "example": "'fr_fr'",
      "description": "Location's phone announcement language."
    },
    "callingLineId": {
      "type": "object",
      "required": [
        "name",
        "phoneNumber"
      ],
      "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",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "$ref": "#/components/schemas/RouteType",
          "description": "Webex Calling location only suppports `TRUNK` and `ROUTE_GROUP` connection type."
        },
        "id": {
          "type": "string",
          "example": "'Y2lzY29zcGFyazovL3VzL1RSVU5LL2M1MGIxZjY2LTRjODMtNDAzNy04NjM1LTg2ZjlkM2VkZDQ5MQ'",
          "description": "A unique identifier of route type."
        }
      },
      "description": "Connection details are only returned for local PSTN types of `TRUNK` or `ROUTE_GROUP`."
    },
    "subscriptionId": {
      "type": "string",
      "example": "'trial'",
      "description": "PSTN connection ID given for locations with a PSTN subscription."
    },
    "externalCallerIdName": {
      "type": "string",
      "example": "'Big Corp Denver'",
      "description": "External Caller ID Name value. Unicode characters."
    },
    "userLimit": {
      "type": "number",
      "example": 500000,
      "description": "Limit on the number of people at the location. Read-Only."
    },
    "pAccessNetworkInfo": {
      "type": "string",
      "example": "'Rcdn'",
      "description": "Emergency Location Identifier for a location. Set this field to provide the SIP access network information to the provider which will be used to populate the SIP P-Access-Network-Info header. This is helpful to establish the location of a device when you make an emergency call."
    },
    "outsideDialDigit": {
      "type": "string",
      "example": "'Rcdn'",
      "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."
    },
    "defaultDomain": {
      "type": "string",
      "example": "'98079822.int10.bcld.webex.com'",
      "description": "IP Address, hostname, or domain. Read-Only."
    },
    "chargeNumber": {
      "type": "string",
      "example": "+14158952369",
      "description": "Chargeable number for the line placing the call. When set and useChargeNumberForPChargeInfo is true, all PSTN calls placed from this location will include a P-Charge-Info header with this specified number in the SIP INVITE."
    },
    "useChargeNumberForPChargeInfo": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether the location's chargeNumber (if set) is enabled for use as the P-Charge-Info header in the SIP INVITE for all PSTN calls placed from this location. The field is returned as true if the location's PSTN allows use of the chargeNumber."
    }
  }
}