Webex · Schema

BuddyAgentRequest

Request payload to retrieve buddy agents.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
agentProfileId	string	The profile ID of a particular agent. Can be obtained from [Users API](/docs/users), maximum length 36 characters.
mediaType	string	The media type for the request. The supported values are ```telephony```, ```chat```, ```social```, ```email``` and ```workItem```.
state	string	It represents the current state of the returned agents which can be either ```Available``` or ```Idle```. If state is omitted from the payload, the API will return a list of both available and idle ag

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BuddyAgentRequest",
  "title": "BuddyAgentRequest",
  "properties": {
    "agentProfileId": {
      "description": "The profile ID of a particular agent. Can be obtained from [Users API](/docs/users), maximum length 36 characters.",
      "type": "string",
      "example": "315fbb91-2288-427c-9588-ec764cd46ea4"
    },
    "mediaType": {
      "description": "The media type for the request. The supported values are ```telephony```, ```chat```, ```social```, ```email``` and ```workItem```.",
      "type": "string",
      "example": "telephony"
    },
    "state": {
      "description": "It represents the current state of the returned agents which can be either ```Available``` or ```Idle```. If state is omitted from the payload, the API will return a list of both available and idle agents. This is useful for consult scenarios, since consulting an idle agent is also supported.",
      "type": "string",
      "example": "Available"
    }
  },
  "required": [
    "agentProfileId",
    "mediaType"
  ],
  "type": "object",
  "description": "Request payload to retrieve buddy agents."
}