Method getobj.call_processing_rules
Description Obtaining call processing rules
Available to Agent, Client

Request parameters

Title Type Required Description
access_token string yes Authentication session key
user_id number no Unique user identifier of the client agent on behalf of which the request is made
Is required for the agent
To obtain a list of client users, you must use the method "get.customer_users"
number_capacity_id number yes Unique virtual number identifier: "get.virtual_numbers"

Response parameters

Name Type Valid values Filtering Sorting Description
Scripts
scenarios array yes List of scripts that are associated with a virtual number
scenario_id number Scenario unique identifier
scenario_name string Scenario name
call_processing_rule_id number Unique identifier of the call processing rule
is_active boolean Is the rule active

JSON request structure```json

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

### JSON response structure```json
{
  "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

See the section "List of errors for methods with the verb get"