ListAdherenceAgentRules

POST

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

Gets all adherence agent @rules for the org sending the request.
Rules will include their respective clauses.
Errors:

grpc.Invalid: the request arguments are invalid.

grpc.Internal: error occurs when getting the rules.

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "rules": [
        {
            "adherence_agent_rule_id": 0,
            "name": "string",
            "selected_entity": {
                "entity_sid": 0,
                "entity_type": "CALL_CENTER_NODE"
            },
            "rule_requirement_type": "ADHERENCE_RULE_REQUIREMENT_TYPE_NOT_USED",
            "adherence_rule_notification_config_id": 0,
            "rule_clauses": [
                {
                    "adherence_agent_rule_clause_id": 0,
                    "adherence_agent_rule_id": 0,
                    "action": {
                        "action_type": "ADHERENCE_AGENT_RULE_ACTION_TYPE_WRAP_UP"
                    },
                    "condition": "ADHERENCE_RULE_CONDITION_GREATER_THAN",
                    "amount": 0,
                    "unit": "ADHERENCE_RULE_UNIT_SECONDS"
                }
            ]
        }
    ]
}

🟢200Success

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

UpdateAdherenceAgentRuleClause

DeleteAdherenceAgentRuleClause