ListValidAgentsForReplacement

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/listvalidagentsforreplacement

Returns a list of @wfm_agent_sids that are suitable for replacing @wfm_agent_sid_to_replace for the given parameters and the org sending the request.
Only enforces that skill proficiencies are covered by the individual wfm agents, does not enforce constraint rules.
If @skip_skill_proficiency_sort is False, the agents will be returned in order of cumulative skill proficiency towards the required skills.
If @include_skill_mismatches is True, the agents will be included even if they do not include all of the required skills for the shifts being replaced.
If @skip_force_same_agent_groups is False, the agents will only be returned if they belong to every agent group that @wfm_agent_sid_to_replace is a member of. Otherwise, this check will be skipped.
Errors:

grpc.Invalid: the request data is invalid.

grpc.Internal: error occurs when determinining which agents are valid.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "schedule_scenario_sid": 0,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "node_selector": {
        "parent_sid": 0,
        "parent_type": "CALL_CENTER_NODE"
    },
    "wfm_agent_sid_to_replace": 0,
    "skip_skill_proficiency_sort": true,
    "include_skill_mismatches": true,
    "skip_force_same_agent_groups": true
}

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/listvalidagentsforreplacement' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "schedule_scenario_sid": 0,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "schedule_selector": {
        "schedule_sid": 0,
        "schedule_type": "DRAFT"
    },
    "node_selector": {
        "parent_sid": 0,
        "parent_type": "CALL_CENTER_NODE"
    },
    "wfm_agent_sid_to_replace": 0,
    "skip_skill_proficiency_sort": true,
    "include_skill_mismatches": true,
    "skip_force_same_agent_groups": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "wfm_agent_sids": [
        0
    ]
}

🟢200Success

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

GenerateTourWeekPatterns

ReplaceAgentOnSchedule