ListAssignedScenarios

List scenarios currently assigned to a given ruleset

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

assigned_scenarios

array[object (AssignedScenario) {3}]

assigned_scenarios

optional

scenario

object (Scenario)

scenario

optional

last_execution_result

object (ScenarioResult)

last_execution_result

optional

enabled

boolean

enabled

optional

Example

{
    "assigned_scenarios": [
        {
            "scenario": {
                "should_allow": {
                    "comm_type": {
                        "call_type": "INBOUND"
                    },
                    "time_of_call": "1s",
                    "phone_type": "CELL",
                    "country_code_data": {
                        "country_name": "string",
                        "country_id": "string",
                        "country_code": 0
                    },
                    "phone_number": "string",
                    "country_code": "string",
                    "email": "string",
                    "dncl_blocks": true,
                    "country": "string",
                    "state": "string",
                    "county": "string",
                    "city": "string",
                    "province": "string",
                    "time_zone": "string",
                    "call_metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "frequency_count": 0,
                    "frequency_duration": 0,
                    "holidays": [
                        "string"
                    ]
                },
                "should_deny": {
                    "comm_type": {
                        "call_type": "INBOUND"
                    },
                    "time_of_call": "1s",
                    "phone_type": "CELL",
                    "country_code_data": {
                        "country_name": "string",
                        "country_id": "string",
                        "country_code": 0
                    },
                    "phone_number": "string",
                    "country_code": "string",
                    "email": "string",
                    "dncl_blocks": true,
                    "country": "string",
                    "state": "string",
                    "county": "string",
                    "city": "string",
                    "province": "string",
                    "time_zone": "string",
                    "call_metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "frequency_count": 0,
                    "frequency_duration": 0,
                    "holidays": [
                        "string"
                    ]
                },
                "last_execution_result": {
                    "passed_value": true,
                    "should_allow_responses": [
                        {
                            "rule_text": "string",
                            "permit_value": true
                        }
                    ],
                    "should_deny_responses": [
                        {
                            "rule_text": "string",
                            "permit_value": true
                        }
                    ],
                    "scenario_name": "string"
                },
                "name": "string",
                "cpl_scenario_id": 0
            },
            "last_execution_result": {
                "passed_value": true,
                "should_allow_responses": [
                    {
                        "rule_text": "string",
                        "permit_value": true
                    }
                ],
                "should_deny_responses": [
                    {
                        "rule_text": "string",
                        "permit_value": true
                    }
                ],
                "scenario_name": "string"
            },
            "enabled": true
        }
    ]
}

🔴500Server Error