Webex · Schema

PbxUser

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
dialPlanName	string	Dial plan name that the called string matches.
dialPlanId	string	Unique identifier for the dial plan.
dialPattern	string	Dial pattern that the called string matches.
trunkName	string	Name of the trunk.
trunkId	string	Unique identifier of the trunk.
routeGroupName	string	Name of the route group.
routeGroupId	string	Unique identifier of the route group.
trunkLocationName	string	Location of the trunk; required if `trunkName` is returned.
trunkLocationId	string	Location ID of the trunk; required if `trunkName` is returned.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PbxUser",
  "title": "PbxUser",
  "type": "object",
  "required": [
    "dialPlanName",
    "dialPlanId",
    "dialPattern"
  ],
  "properties": {
    "dialPlanName": {
      "type": "string",
      "example": "dialPlan1",
      "description": "Dial plan name that the called string matches."
    },
    "dialPlanId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
      "description": "Unique identifier for the dial plan."
    },
    "dialPattern": {
      "type": "string",
      "example": "442xxx",
      "description": "Dial pattern that the called string matches."
    },
    "trunkName": {
      "type": "string",
      "example": "trunkName1",
      "description": "Name of the trunk."
    },
    "trunkId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzA4Yjc2MmZlLWJmYWItNGFmYi04ODQ1LTNhNzJjNGQ0NjZiOQ",
      "description": "Unique identifier of the trunk."
    },
    "routeGroupName": {
      "type": "string",
      "example": "routeGroupName1",
      "description": "Name of the route group."
    },
    "routeGroupId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQL2YyODkyMTc0LWYxM2YtNDhjYy1iMmJhLWQ4ZmM4Yzg4MzJhYg",
      "description": "Unique identifier of the route group."
    },
    "trunkLocationName": {
      "type": "string",
      "example": "trunkLocationName1",
      "description": "Location of the trunk; required if `trunkName` is returned."
    },
    "trunkLocationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
      "description": "Location ID of the trunk; required if `trunkName` is returned."
    }
  }
}