ListCandidateSchedulingActivities

Lists the candidate scheduling activities for a constraint or placement rule, inherited through given @parent_of_rule for @schedule_scenario_sid for the org making the request.
@parent_of_rule may be any type of node, agent group, or shift template which the rule will belong to.
If the rule will belong to a wfm agent, the agent group must be supplied instead to get a relevant set of candidate scheduling activities.
Member non skill activity of each scheduling activity will be included in the response.
The on call scheduling activity will always be included.
Reason codes will be included with the returned scheduling activities.
Errors:

grpc.Invalid: the @parent_of_rule is invalid.

grpc.NotFound: @parent_of_rule doesn't exist

grpc.Internal: error occurs when applying inheritance or getting the nodes from @parent_of_rule.

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

parent_of_rule

object (ParentEntity)

parent_of_rule

optional

The parent who the rule will inherit candidate scheduling activities from.
May be any node, an agent_group, or shift template.
To get candidate scheduling activities for rules belonging to a wfm agent, @parent_of_rule should be the agent group the wfm agent belongs to.

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

schedule_scenario_sid

integer <int64> | string

schedule_scenario_sid

optional

ID of the schedule scenario that this activity belongs to.

Example

{
  "parent_of_rule": {
    "parent_type": "CALL_CENTER_NODE",
    "parent_sid": 0
  },
  "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 ListCandidateSchedulingActivitiesRes RPC

scheduling_activities

array[object (SchedulingActivity) {7}]

scheduling_activities

optional

activity_sid

optional

ID for non-skill activity if @is_skill_activity is false, or for a skill activity if @is_skill_activity is true.
This is nil by default, meaning the scheduling_activity refers to a call.

member_non_skill_activity

object (NonSkillActivity)

member_non_skill_activity

optional

The non skill activity associated with @activity_sid if @is_skill_activity is false.

activity_classification

enum<string>

activity_classification

optional

Distinguishes if this is a special scheduling activity.

Allowed values:

STANDARD_SCHEDULING_ACTIVITYON_CALL_ACTIVITYTIME_OFF_ACTIVITYMEETING_ACTIVITY

is_skill_activity

boolean

is_skill_activity

optional

If false, the @idActivity refers to the id for a non-skill activity, if true then @activity_sid refers to all calls for any skill.

reason_codes

array[object (ReasonCode) {7}]

reason_codes

optional

List of all reason codes associated with this activity.

scheduling_activity_sid

integer <int64> | string

scheduling_activity_sid

optional

ID of this scheduling activity.

pause_codes

array[string]

pause_codes

optional

List of all the pause codes that this activity allows.

Example

{
  "scheduling_activities": [
    {
      "activity_sid": "string",
      "member_non_skill_activity": {
        "datetime_set_to_inactive": "1s",
        "inherited_from_entity": {
          "parent_type": "CALL_CENTER_NODE",
          "parent_sid": 0
        },
        "name": "string",
        "description": "string",
        "red": 0,
        "green": 0,
        "blue": 0,
        "transparency": 0,
        "non_skill_activity_sid": 0
      },
      "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
      "is_skill_activity": true,
      "reason_codes": [
        {
          "datetime_set_to_inactive": "1s",
          "name": "string",
          "is_planned": true,
          "is_paid": true,
          "is_default": true,
          "reason_code_id": 0,
          "scheduling_activity_sid": 0
        }
      ],
      "scheduling_activity_sid": 0,
      "pause_codes": [
        "string"
      ]
    }
  ]
}

🔴500Server Error