ProcessOutboundCall

POST

https://api.cbf.tcn.com/api/v0alpha/compliance/processoutboundcall

Process and Outbound Phone Number against a rule set.
The method will return a response indicating
if the call would be permited or not and the list
of rules checked against.
Required permissions:
AGENT

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "rule_set_name": "string",
    "country_code": "string",
    "phone_number": "string",
    "call_metadata": {
        "property1": "string",
        "property2": "string"
    },
    "source_id": 0,
    "source_field": "string",
    "caller_id": "string",
    "client_sid": 0,
    "comm_type": {
        "call_type": "INBOUND"
    },
    "call_type": "string",
    "org_id": "string",
    "region_id": "string",
    "email": "string",
    "zip_code": "string"
}

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/v0alpha/compliance/processoutboundcall' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "rule_set_name": "string",
    "country_code": "string",
    "phone_number": "string",
    "call_metadata": {
        "property1": "string",
        "property2": "string"
    },
    "source_id": 0,
    "source_field": "string",
    "caller_id": "string",
    "client_sid": 0,
    "comm_type": {
        "call_type": "INBOUND"
    },
    "call_type": "string",
    "org_id": "string",
    "region_id": "string",
    "email": "string",
    "zip_code": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "permit": true,
    "rule_responses": [
        {
            "rule_text": "string",
            "permit": true,
            "plugin_response": "string"
        }
    ]
}

🟢200Success

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

UpdateConsentTopic

QueryHolidays