Webex · Schema

SelectedCallerIdSettingsPut

Request Payload to update selected caller ID settings.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

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

JSON Schema

webex-selectedcalleridsettingsput-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SelectedCallerIdSettingsPut",
  "title": "SelectedCallerIdSettingsPut",
  "type": "object",
  "description": "Request Payload to update selected caller ID settings.",
  "required": [
    "selected"
  ],
  "properties": {
    "selected": {
      "type": "object",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "$ref": "#/components/schemas/CallerIdType"
        },
        "id": {
          "type": "string",
          "example": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvNmU1NTVjZDAtNjM0MS00MmI4LWEyMWMtZTc1ZjIxNDQ4Mjc1",
          "description": "Unique identifier of the selected caller ID (HuntGroup / CallQueue) config. Required only when setting `CALL_QUEUE` or `HUNT_GROUP` caller IDs."
        },
        "directNumber": {
          "type": "string",
          "example": "+19075552859",
          "description": "Direct number of the selected caller ID. Required only when setting ADDITIONAL_CLID as the selected caller ID."
        }
      },
      "description": "Selected caller ID settings."
    }
  }
}