Webex · Schema

AvailableCallerIdObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Call queue or hunt group's unique identifier.
type object Member is of type `CALL_QUEUE` or `HUNT_GROUP`.
name string Call queue or hunt group's name.
phoneNumber string When not null, it is call queue or hunt group's phone number.
extension string When not null, it is call queue or hunt group's extension number.
View JSON Schema on GitHub

JSON Schema

webex-availablecalleridobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AvailableCallerIdObject",
  "title": "AvailableCallerIdObject",
  "type": "object",
  "required": [
    "id",
    "type",
    "name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvMjE3ZDU3YmEtOTMxYi00ZjczLTk1Y2EtOGY3MWFhYzc4MTE5",
      "description": "Call queue or hunt group's unique identifier."
    },
    "type": {
      "$ref": "#/components/schemas/AgentCallerIdType",
      "description": "Member is of type `CALL_QUEUE` or `HUNT_GROUP`."
    },
    "name": {
      "type": "string",
      "example": "TestCallQueue",
      "description": "Call queue or hunt group's name."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+441234200090",
      "description": "When not null, it is call queue or hunt group's phone number."
    },
    "extension": {
      "type": "string",
      "example": "6001",
      "description": "When not null, it is call queue or hunt group's extension number."
    }
  }
}