BuildAgentDiagnostics

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/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

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/buildagentdiagnostics' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "wfm_agent_sid": 0,
    "schedule_scenario_sid": 0,
    "agent_group_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

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

🟢200Success

Modified at 2025-09-26 15:44:58

RemoveAgentFromFutureShifts

CreateShiftTemplate