BuildAgentDiagnostics

Builds and returns the diagnostics for the wfm agent associated with the given @wfm_agent_sid or @agent_group_sid for the org sending the request.
Response will only contain:
one element if build for a single @wfm_agent_sid.
one element for each WFM agent if build for an @agent_group_sid.

grpc.Invalid: the @wfm_agent_sid, or @agent_group_sid is invalid.

grpc.NotFound: the given @wfm_agent_sid doesn't exist or the @agent_group_sid has no agents.

grpc.Internal: error occurs building the diagnostics.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the BuildAgentDiagnostics RPC

wfm_agent_sid

integer <int64> | string

wfm_agent_sid

optional

ID of the wfm agent to build diagnostics for.

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

ID of the schedule scenario that the wfm agent belongs to.

agent_group_sid

integer <int64> | string

agent_group_sid

optional

ID of the agent_group to build diagnostics for.
If this field is set, the diagnostics will be built for every wfm agent in that agent group, and the @wfm-agent_sid field in this req will be ignored.

Example

{
  "wfm_agent_sid": 0,
  "schedule_scenario_sid": 0,
  "agent_group_sid": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response message for the BuildAgentDiagnostics RPC

diagnostics

array[object (Diagnostics) {2}]

diagnostics

optional

Diagnostics built for the given req.
Will only contain one element if build for a single @wfm_agent_sid.
Will contain one element for each WFM agent if build for an @agent_group_sid.a

source_entity

object (ParentEntity)

source_entity

optional

The entity that the diagnostics built reference.

diagnostics

array[object (Diagnostic) {4}]

diagnostics

optional

Diagnostics generated for the @source_entity

Example

{
  "diagnostics": [
    {
      "source_entity": {
        "parent_type": "CALL_CENTER_NODE",
        "parent_sid": 0
      },
      "diagnostics": [
        {
          "level": "INFORMATION",
          "code": "GENERAL",
          "source_entity": {
            "parent_type": "CALL_CENTER_NODE",
            "parent_sid": 0
          },
          "message": "string"
        }
      ]
    }
  ]
}

🔴500Server Error