Webex · Schema

Destination

Destination for the task. Use `businessAddress` type for `workItem` tasks and `dialNumber` type for `telephony` tasks.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string Destination identifier. For `workItem` tasks, this is the business address associated with the configured workItem channel entry point. For `telephony` tasks, this is the dial number to call. **Migrat
type string Destination type. Use `businessAddress` for `workItem` tasks and `dialNumber` for `telephony` tasks.
View JSON Schema on GitHub

JSON Schema

webex-destination-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Destination",
  "title": "Destination",
  "type": "object",
  "description": "Destination for the task. Use `businessAddress` type for `workItem` tasks and `dialNumber` type for `telephony` tasks.",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Destination identifier. For `workItem` tasks, this is the business address associated with the configured workItem channel entry point. For `telephony` tasks, this is the dial number to call. **Migrating from v1:** Previously the top-level `destination` field (plain string) for telephony.",
      "example": "[email protected]"
    },
    "type": {
      "type": "string",
      "description": "Destination type. Use `businessAddress` for `workItem` tasks and `dialNumber` for `telephony` tasks.",
      "enum": [
        "businessAddress",
        "dialNumber"
      ],
      "example": "businessAddress"
    }
  }
}