Webex · Schema

ActionResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
data object The data object contains the details of the action taken.
trackingId string The unique tracking ID for this request.
View JSON Schema on GitHub

JSON Schema

webex-actionresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ActionResponse",
  "title": "ActionResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "description": "The data object contains the details of the action taken.",
      "properties": {
        "id": {
          "type": "string",
          "description": "A unique identifier for the action taken.",
          "example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
        },
        "interactionId": {
          "type": "string",
          "description": "A unique identifier for each interaction or contact within the contact center.",
          "example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
        },
        "orgId": {
          "type": "string",
          "description": "The organization ID to which the agent belongs.",
          "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
        },
        "agentId": {
          "type": "string",
          "description": "The identifier for the agent whose burnout index has been calculated.",
          "example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
        },
        "clientId": {
          "type": "string",
          "description": "The name of the client initiating the action related to the agent burnout index. The name is limited to a maximum of 20 characters.",
          "example": "Acme"
        },
        "actionType": {
          "type": "string",
          "description": "Specifies the type of action initiated based on the agent burnout index",
          "example": "Break Played, Supervisor Notified, etc."
        },
        "actionDateTime": {
          "type": "integer",
          "description": "The Epoch timestamp indicating the precise time at which the action was executed.",
          "format": "int64",
          "example": 1617536244000
        },
        "createdDateTime": {
          "type": "integer",
          "description": "The Epoch timestamp indicating the time when the action was created.",
          "format": "int64",
          "example": 1617536244000
        }
      }
    },
    "trackingId": {
      "type": "string",
      "description": "The unique tracking ID for this request.",
      "example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
    }
  }
}