Webex · Schema

PostCallPickupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
name string Unique name for the call pickup. The maximum length is 80.
notificationType string Type of the notification when an incoming call is unanswered. The call pickup group notifies all of its members. Default: NONE. * `NONE` - Notification is not sent to any member of the call pickup gro
notificationDelayTimerSeconds number After the number of seconds given by the `notificationDelayTimerSeconds` has elapsed, notify every member of the call pickup group when an incoming call goes unanswered. The `notificationType` field s
agents array An Array of ID strings of people, workspaces and virtual lines that are added to call pickup.
View JSON Schema on GitHub

JSON Schema

webex-postcallpickupobject-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostCallPickupObject",
  "title": "PostCallPickupObject",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "North Alaska-Group",
      "description": "Unique name for the call pickup. The maximum length is 80."
    },
    "notificationType": {
      "type": "string",
      "enum": [
        "NONE",
        "AUDIO_ONLY",
        "VISUAL_ONLY",
        "AUDIO_AND_VISUAL"
      ],
      "description": "Type of the notification when an incoming call is unanswered. The call pickup group notifies all of its members. Default: NONE.\n * `NONE` - Notification is not sent to any member of the call pickup group.\n * `AUDIO_ONLY` - When the notificationDelayTimerSeconds number of seconds has elapsed, play an audio notification for each call pickup group member.\n * `VISUAL_ONLY` - When the notificationDelayTimerSeconds number of seconds has elapsed, provide a visual notification to every call pickup group member.\n * `AUDIO_AND_VISUAL` - When the `notificationDelayTimerSeconds` number of seconds has elapsed, provide an audio and visual notification to every call pickup group member.\n"
    },
    "notificationDelayTimerSeconds": {
      "type": "number",
      "example": 6,
      "description": "After the number of seconds given by the `notificationDelayTimerSeconds` has elapsed, notify every member of the call pickup group when an incoming call goes unanswered. The `notificationType` field specifies the notification method. Default: 6."
    },
    "agents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An Array of ID strings of people, workspaces and virtual lines that are added to call pickup."
    }
  }
}