Access Control Rule Object

The Access Control Rule (ACR) Object represents an individual matching condition that determines whether a call or SMS satisfies specific criteria.

A rule consists of:

• A field to evaluate (e.g., destination number),
• A set of entries to match against that field,
• An operation that defines how to compare,
• A quantifier that determines how many entries must match.

Rules are reusable across Access Control Lists. Depending on how you combine them, you can build fine-grained access control strategies — for example, blocking entire number ranges, allowing only specific patterns, or rejecting traffic outside of a defined set.

Access Control Rule Object Attributes

These fields and values make up the JSON object that gets returned with successful requests.

Attribute	Data Type	Description
entries createupdate	array	The list of entries to compare against the field value.
field createupdate	string	The field from the call or SMS to check. This value will be used in comparison with entries.
name createupdate	string	The access control rule name. The value will be set to N/A if not specified otherwise.
operation createupdate	string	Determines how the value is checked. Values accepted in this field are: exact for the exact match of the entries with the field value. prefix for the entries to match only the beginning of the field value. regexp for the entries which are the regular expressions instead of the exact values.
quantifier createupdate	string	The type of comparison to be made between entries and field. Values accepted in this field are: all to determine that all the entries must be matched for the rule to work. any to determine that at least one of the entries must be matched for the rule to work. none to determine that none of the entries must match for the rule to work.
read_only read only	boolean	Shows whether the access control rule can be modified or not. Values accepted in this field are: false to allow the rule modifications. true to protect the rule from being edited. The default value is false for the rules created by the partner, true for the rules created by the parent partner.
rule_sid read only	string	The access control rule secure ID.

Sample Access Control Rule Object

{
    "entries": [
        "1800",
        "1615"
    ],
    "field": "to",
    "name": "N/A",
    "operation": "prefix",
    "quantifier": "any",
    "read_only": false,
    "rule_sid": "c9109b54-13f2-4157-ba23-2984b3a207dc"
}