Webex · Schema

WrapUpResourceRequest

Request body for wrapping up a task.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
auxCodeId string Auxiliary codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of ea
wrapUpReason string Every wrap up reason will have an unique auxillary code. Use this field to specify the reason for wrapping up the call, maximum length 128 characters.
View JSON Schema on GitHub

JSON Schema

webex-wrapupresourcerequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/WrapUpResourceRequest",
  "title": "WrapUpResourceRequest",
  "description": "Request body for wrapping up a task.",
  "properties": {
    "auxCodeId": {
      "description": "Auxiliary codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of each for the agent to use. Idle codes are used to explain an agent's unavailability to take customer contacts, such as during a lunch break or a meeting. Wrap-up codes indicate the result of customer contacts, such as successful resolution or escalation of the contact. Creating and managing auxiliary codes requires an administrator role and the appropriate cjp:config_write or cjp:config_read scopes, maximum length 36 characters.",
      "type": "string",
      "example": "AXUH3oN12eV-WekpnDpl"
    },
    "wrapUpReason": {
      "description": "Every wrap up reason will have an unique auxillary code. Use this field to specify the reason for wrapping up the call, maximum length 128 characters.",
      "type": "string",
      "example": "Sales"
    }
  },
  "required": [
    "wrapUpReason",
    "auxCodeId"
  ],
  "type": "object"
}