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

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 GetAvailabilityBitmaps RPC

datetime_range

object (DatetimeRange)

datetime_range

optional

Datetime range that bitmaps will cover when generated for @entities_to_check.

start_datetime

string <date-time>

start_datetime

optional

begining datetime

Examples:

1s1.000340012s

end_datetime

string <date-time>

end_datetime

optional

ending datetime

Examples:

1s1.000340012s

bitmap_type

enum<string>

bitmap_type

optional

Indicates the type of bitmaps to generate.

Allowed values:

COMPLETEONLY_WEEKMAPSONLY_CALENDAR_ITEMS

entities_to_check

array[object (ParentEntity) {2}]

entities_to_check

optional

The entities that @bitmaps will be associated with.
Must be nodes, wfm agents, and agent groups only. For agent groups, bitmaps will be returned for each of the groups member agents,

parent_type

enum<string>

parent_type

optional

Type of entity that the @parent_sid will reference.

Allowed values:

CALL_CENTER_NODECLIENT_NODELOCATION_NODEPROGRAM_NODEAGENT_GROUPSHIFT_TEMPLATEWFM_AGENTPLACEMENT_RULECONSTRAINT_RULENON_SKILL_ACTIVITYAGENT_AVAILABILITYOPEN_TIMESSCHEDULING_ACTIVITYSKILL_PROFICIENCYSCHEDULE_SCENARIOSKILLTOUR_PATTERNTOUR_WEEK_PATTERNTOUR_SHIFT_INSTANCE_CONFIGTOUR_SHIFT_SEGMENT_CONFIGTOUR_AGENT_COLLECTION

parent_sid

integer <int64> | string

parent_sid

optional

ID of a parent entity

include_inactive

boolean

include_inactive

optional

Whether or not to include inactive nodes. Will need to be set to true if @entities_to_check or any of it's parents are inactive.

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

ID of the schedule scenario that @entities_to_check belong to.

Example

{
  "datetime_range": {
    "start_datetime": "1s",
    "end_datetime": "1s"
  },
  "bitmap_type": "COMPLETE",
  "entities_to_check": [
    {
      "parent_type": "CALL_CENTER_NODE",
      "parent_sid": 0
    }
  ],
  "include_inactive": true,
  "schedule_scenario_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 GetAvailabilityBitmaps RPC

bitmaps

array[object (AvailabilityBitmapSet) {4}]

bitmaps

optional

Requested bitmaps, with a pointer to the entity that the bitmaps belong.

parent_entity

object (ParentEntity)

parent_entity

optional

Entity that the bitmaps belong to.

own_bitmap

array[string]

own_bitmap

optional

Map of availability options belonging to the node being checked.

Allowed values:

AVAILABLENOT_AVAILABLEPREFER_NOT_AVAILABLE

inherited_bitmap

array[string]

inherited_bitmap

optional

Map of availability options inherited from parent nodes.

Allowed values:

AVAILABLENOT_AVAILABLEPREFER_NOT_AVAILABLE

resulting_bitmap

array[string]

resulting_bitmap

optional

Map of availability options resulting from combining the inherited and own bitmap.

Allowed values:

AVAILABLENOT_AVAILABLEPREFER_NOT_AVAILABLE

Example

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

🔴500Server Error