Retrieves call processing rules for a virtual number

Method	getobj.call_processing_rules
Description	Retrieves call processing rules for a virtual number
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".
number_capacity_id	number	yes	Unique virtual number ID. Retrieve available IDs with "get.virtual_numbers".

Response parameters

Name	Type	Valid values	Filtering	Sorting	Description
Scenarios
scenarios	array		yes		Scenarios associated with the virtual number
scenario_id	number				Unique scenario ID
scenario_name	string				Scenario name
call_processing_rule_id	number				Unique call processing rule ID
is_active	boolean				Indicates whether the rule is active

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"getobj.call_processing_rules",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "number_capacity_id":"number"
  }
}

JSON response structure

{
  "jsonrpc": "2.0",
  "id": "number",
  "result": {
    "metadata": {},
    "data":
      {
        "scenarios": [
          {
            "scenario_id": "number",
            "scenario_name": "string",
            "is_active": "boolean",
            "call_processing_rule_id": "number"
          }
        ]
      }
  }
}

List of returned errors

For errors common to all methods, see the Data API — General documentation.