Skip to main content

Access Control List Object

This section describes the elements of the Access Control List object.

Access Control List Object Attributes

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

AttributeData TypeDescription
access_control_rules
read only
array

The list of access control rules secure IDs. Refer to the Access Control Rule object for more information about access control rules.

direction
read only
string
The direction for the access control list. Values accepted in this field are:
  • any to apply the rules from the list to both sent and received calls and messages.
  • inbound to apply the rules from the list to received calls and messages.
  • outbound to apply the rules from the list to sent calls and messages.
  • undirected to apply the rules from the list to actions with no direction specified.
sms_action_false
read only
string

The action to be executed for SMS messages if no access control rules are applied. Values accepted in this field are accept and reject.

sms_action_true
read only
string

The action to be executed for SMS messages if any access control rules are applied. Values accepted in this field are accept and reject.

voice_action_false
read only
string
The action to be executed for calls if no access control rules are applied. Values accepted in this field are:
  • accept to accept the calls.
  • reject403 to reject the call with the 403 status code.
  • reject503 to reject the call with the 503 status code.
voice_action_true
read only
string
The action to be executed for calls if any access control rules are applied. Values accepted in this field are:
  • accept to accept the calls.
  • reject403 to reject the call with the 403 status code.
  • reject503 to reject the call with the 503 status code.
note

Please note that for the Trunk Group and the Trunk Objects the sms_action_false and sms_action_true fields are always null and read-only because Trunk Groups and Trunks are used for voice only.

Sample Access Control List Object

{
"access_control_rules": [
"dafd993d-0e99-4af9-b8fc-436fb01b0bbe",
"6fd782fa-c80b-4299-9b91-78797eb392e1"
],
"direction": "outbound",
"sms_action_false": null,
"sms_action_true": null,
"voice_action_false": null,
"voice_action_true": "reject503"
}