Webex · Schema

SelectedCallerIdSettingsGet

Response object for the selected caller ID settings.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
selected object Selected caller ID settings.
View JSON Schema on GitHub

JSON Schema

webex-selectedcalleridsettingsget-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectedCallerIdSettingsGet",
  "title": "SelectedCallerIdSettingsGet",
  "type": "object",
  "description": "Response object for the selected caller ID settings.",
  "example": {
    "selected": {
      "type": "CALL_QUEUE",
      "id": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1",
      "name": "Call Queue DND",
      "directNumber": "+19075552859",
      "extension": "10079"
    }
  },
  "required": [
    "selected"
  ],
  "properties": {
    "selected": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/components/schemas/CallerIdType"
        },
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1",
          "description": "Unique identifier of the selected caller ID config. Set for `CALL_QUEUE` & `HUNT_GROUP` caller IDs."
        },
        "name": {
          "type": "string",
          "example": "Call Queue DND",
          "description": "Name of the selected caller ID."
        },
        "directNumber": {
          "type": "string",
          "example": "+19075552859",
          "description": "Direct number of the selected caller ID."
        },
        "extension": {
          "type": "string",
          "example": "10079",
          "description": "Extension of the selected caller ID."
        }
      },
      "description": "Selected caller ID settings."
    }
  }
}