Webex · Schema

CallbackParams

Callback parameters for telephony tasks.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
type string Callback execution mode. Currently only `immediate` is supported. **Migrating from v1:** Previously named `callbackType`.
origin string Channel that originated the callback request. The supported value is `web`. **Migrating from v1:** Previously named `callbackOrigin`.
number string Optional callback number. Provided when the callback flow supplies a specific number to dial back.
View JSON Schema on GitHub

JSON Schema

webex-callbackparams-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CallbackParams",
  "title": "CallbackParams",
  "type": "object",
  "description": "Callback parameters for telephony tasks.",
  "required": [
    "type",
    "origin"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Callback execution mode. Currently only `immediate` is supported. **Migrating from v1:** Previously named `callbackType`.",
      "enum": [
        "immediate"
      ],
      "example": "immediate"
    },
    "origin": {
      "type": "string",
      "description": "Channel that originated the callback request. The supported value is `web`. **Migrating from v1:** Previously named `callbackOrigin`.",
      "enum": [
        "web"
      ],
      "example": "web"
    },
    "number": {
      "type": "string",
      "nullable": true,
      "description": "Optional callback number. Provided when the callback flow supplies a specific number to dial back.",
      "example": "+19780000000"
    }
  }
}