Enables or disables a call processing rule
Virtual Numbers >
Enables or disables a call processing rule
Method
set.call_processing_rule_is_active
Description
Enables or disables a call processing rule
Who has access
Agents and clients
Request parameters
Name
Type
Required
Description
access_token
string
yes
Session key used to authenticate the request
user_id
number
no
Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call "get.customer_users" .
id
number
yes
Unique call processing rule ID. Retrieve available IDs with "getobj.call_processing_rules" .
type
enum
yes
Rule type. Valid value: scenario.
is_active
boolean
yes
Whether the rule is active
JSON request structure
{
"jsonrpc":"2.0",
"id":"number",
"method":"set.call_processing_rule_is_active",
"params":{
"access_token":"string",
"user_id":"number",
"id": "number",
"type": "enum",
"is_active": "boolean"
}
}
JSON response structure
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": {},
"metadata": {}
}
}
List of returned errors
For errors common to all methods, see the Data API — General documentation .