Webex · Schema

AgentActivity

List of agent activities retrieved according to query parameters.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
active boolean Active indicates whether the activity is completed (false) or in progress (true).
agentId string Unique identifier of an agent.
agentDn string Dialed number for the agent.
agentLogin string Login username of the agent.
agentSessionId string Agent Session Id
agentName string The name of the agent.
currentState string The activity state (e.g. idle, available, connected, etc.).
siteId string Unique identifier for a site.
siteName string The name of the site.
teamId string Unique identifier for a team.
teamName string The name of the team.
isLogin integer Indicates whether the activity was the login event (1) or not (0).
taskId string Unique identifier for a task.
channelId string Unique identifier for the channel.
channelType string Channel type for the activity (e.g. email, telephony, chat, etc.).
subChannelType string SubChannel type for the activity.
idleCodeName string In case of an idle activity, it will have an idle code attached with it (e.g. Break, Meeting, Lunch, etc.).
idleCode string Unique identifier for the idle code.
queueId string Unique identifier for the queue.
queueName string The name of the Queue.
wrapupCodeName string Selected wrapup code upon finished task.
reason string Reason
startTime integer Epoch timestamp in milliseconds of the start of the activity.
endTime integer Epoch timestamp in milliseconds of the end of the activity. If active, it will be -1.
mmProfileType string Multimedia profile type
View JSON Schema on GitHub

JSON Schema

webex-agentactivity-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AgentActivity",
  "title": "AgentActivity",
  "required": [
    "active",
    "agentDn",
    "agentId",
    "agentLogin",
    "agentName",
    "agentSessionId",
    "channelId",
    "channelType",
    "currentState",
    "endTime",
    "idleCode",
    "idleCodeName",
    "isLogin",
    "mmProfileType",
    "queueId",
    "queueName",
    "reason",
    "siteId",
    "siteName",
    "startTime",
    "subChannelType",
    "taskId",
    "teamId",
    "teamName",
    "wrapupCodeName"
  ],
  "type": "object",
  "properties": {
    "active": {
      "type": "boolean",
      "description": "Active indicates whether the activity is completed (false) or in progress (true).",
      "example": true
    },
    "agentId": {
      "type": "string",
      "description": "Unique identifier of an agent.",
      "example": "AWn8XmdC-MmYjwcdYK2i"
    },
    "agentDn": {
      "type": "string",
      "description": "Dialed number for the agent.",
      "example": "5555555"
    },
    "agentLogin": {
      "type": "string",
      "description": "Login username of the agent.",
      "example": "[email protected]"
    },
    "agentSessionId": {
      "type": "string",
      "description": "Agent Session Id",
      "example": "72a79e8b-6d2e-4423-869a-01bfebc081e6"
    },
    "agentName": {
      "type": "string",
      "description": "The name of the agent.",
      "example": "John Smith"
    },
    "currentState": {
      "type": "string",
      "description": "The activity state (e.g. idle, available, connected, etc.).",
      "example": "idle"
    },
    "siteId": {
      "type": "string",
      "description": "Unique identifier for a site.",
      "example": "AWn8XmdC-MmYjwcdYK2i"
    },
    "siteName": {
      "type": "string",
      "description": "The name of the site.",
      "example": "Austin"
    },
    "teamId": {
      "type": "string",
      "description": "Unique identifier for a team.",
      "example": "AWn8XmdC-MmYjwcdYK2i"
    },
    "teamName": {
      "type": "string",
      "description": "The name of the team.",
      "example": "email"
    },
    "isLogin": {
      "type": "integer",
      "description": "Indicates whether the activity was the login event (1) or not (0).",
      "format": "int32",
      "example": 1
    },
    "taskId": {
      "type": "string",
      "description": "Unique identifier for a task.",
      "example": "35d88b03-6c43-45e4-9fba-99b728ad4750"
    },
    "channelId": {
      "type": "string",
      "description": "Unique identifier for the channel.",
      "example": "35d88b03-6c43-45e4-9fba-99b728ad4750"
    },
    "channelType": {
      "type": "string",
      "description": "Channel type for the activity (e.g. email, telephony, chat, etc.).",
      "example": "email"
    },
    "subChannelType": {
      "type": "string",
      "description": "SubChannel type for the activity.",
      "example": "email"
    },
    "idleCodeName": {
      "type": "string",
      "description": "In case of an idle activity, it will have an idle code attached with it (e.g. Break, Meeting, Lunch, etc.).",
      "example": "Break"
    },
    "idleCode": {
      "type": "string",
      "description": "Unique identifier for the idle code.",
      "example": "AWn8XmdC-MmYjwcdYK2i"
    },
    "queueId": {
      "type": "string",
      "description": "Unique identifier for the queue.",
      "example": "AWn8XmdC-MmYjwcdYK2i"
    },
    "queueName": {
      "type": "string",
      "description": "The name of the Queue.",
      "example": "Support Queue"
    },
    "wrapupCodeName": {
      "type": "string",
      "description": "Selected wrapup code upon finished task.",
      "example": "Sale"
    },
    "reason": {
      "type": "string",
      "description": "Reason",
      "example": "reason"
    },
    "startTime": {
      "type": "integer",
      "description": "Epoch timestamp in milliseconds of the start of the activity.",
      "format": "int64",
      "example": 1605169648658
    },
    "endTime": {
      "type": "integer",
      "description": "Epoch timestamp in milliseconds of the end of the activity. If active, it will be -1.",
      "format": "int64",
      "example": 1605169648658
    },
    "mmProfileType": {
      "type": "string",
      "description": "Multimedia profile type",
      "example": "blended"
    }
  },
  "description": "List of agent activities retrieved according to query parameters."
}