Webex · Schema

ConsultResourceRequest

Request body for a consult.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
to string The destination ID to consult, maximum length 36 characters.
destinationType string The user can consult to another user in the team(```agent```), queue(```queue```), entry point(```entryPoint```) or dial number(```dialNumber```). When consulting an Entry Point (EP) that is associate
holdParticipants boolean This allows the caller to specify their preference for whether the main call should be placed on hold or not during consult.
View JSON Schema on GitHub

JSON Schema

webex-consultresourcerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConsultResourceRequest",
  "title": "ConsultResourceRequest",
  "description": "Request body for a consult.",
  "properties": {
    "to": {
      "description": "The destination ID to consult, maximum length 36 characters.",
      "type": "string",
      "example": "315fbb91-2288-427c-9588-ec764cd46ea4"
    },
    "destinationType": {
      "description": "The user can consult to another user in the team(```agent```), queue(```queue```), entry point(```entryPoint```) or dial number(```dialNumber```).\n When consulting an Entry Point (EP) that is associated with multiple Directory Numbers (DNs), the consult typically goes to one of the associated DNs.",
      "type": "string",
      "example": "dialNumber"
    },
    "holdParticipants": {
      "description": "This allows the caller to specify their preference for whether the main call should be placed on hold or not during consult.",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "to",
    "destinationType"
  ],
  "type": "object"
}