GetOnCallSchedulingActivity

POST

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

Gets the on call scheduling activity for the org sending the request.
Reason codes will be included with the returned scheduling activity.
Required permissions:
NONE
Errors:
-grpc.NotFound: the on call scheduling activity for the org is not found.
-grpc.Internal: error occurs when getting on call scheduling activity.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{}

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/getoncallschedulingactivity' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{}'

Responses

🟢200OK

application/json

Success

Body

Example

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

🟢200Success

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

ListSchedulingActivities

CreateSchedulingActivityPauseCodes