GetAvailabilityBitmaps

POST

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

Gets the inherited, own, and resulting bitmaps for the agent availability patterns of @entities_to_check for @schedule_scenario_sid and the org sending the request.
The @schedule_scenario_sid must match the scenario of the @entities_to_check.
@entities_to_check must have the entity_type field set with a wfm agent, agent group or a type of node.
If an availability bitmap is requested for an agent group, the bitmaps for all of it's member agents will be returned instead.
The bitmaps will be generated for the span of @datetime_range.
If @bitmap_type is COMPLETE, the bitmaps will be generated using all relevant pattern data.
If @bitmap_type is ONLY_WEEKMAPS, the bitmaps will be generated using only the weekmap data from the availability patterns.
If @bitmap_type is ONLY_CALENDAR_ITEMS, the bitmaps will be generated using only the calendar item data from the availability patterns.
Errors:

grpc.Invalid: the @entities_to_check is invalid for @schedule_scenario_sid and the org making the request.
: the @datetime_range is invalid.

grpc.NotFound: the given @entities_to_check don't exist.

grpc.Internal: error occurs when getting the agent availability pattern bitmaps.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "entities_to_check": [
        {
            "parent_sid": 0,
            "parent_type": "CALL_CENTER_NODE"
        }
    ],
    "schedule_scenario_sid": 0,
    "include_inactive": true,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "bitmap_type": "COMPLETE"
}

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/getavailabilitybitmaps' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entities_to_check": [
        {
            "parent_sid": 0,
            "parent_type": "CALL_CENTER_NODE"
        }
    ],
    "schedule_scenario_sid": 0,
    "include_inactive": true,
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "bitmap_type": "COMPLETE"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "bitmaps": [
        {
            "own_bitmap": [
                "AVAILABLE"
            ],
            "inherited_bitmap": [
                "AVAILABLE"
            ],
            "resulting_bitmap": [
                "AVAILABLE"
            ],
            "parent_entity": {
                "parent_sid": 0,
                "parent_type": "CALL_CENTER_NODE"
            }
        }
    ]
}

🟢200Success

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

DeleteAgentAvailabilityPattern

UpsertNonSkillActivityAssociation