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.

Attribute	Data Type	Description
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"
}

Look Up Effective ACLs for Calls

This request returns a list of effective Access Control Lists (ACLs) for calls for a partner, a trunk group and trunk, targeted by secure ID.

get	/accesscontrol/effective_acl/calls

Sample

A sample GET request to get effective ACLs for calls:

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/effective_acl/calls' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Access Control List objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "effective_acls": [
                {
                    "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"
                }
            ],
            "layer": 1
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {},
    "total": 1
}

note

Note that effective ACLs are executed from the most top-level object.

This request is enabled for Field Filtering. Additionally, query arguments are used to narrow the results.

Required Scopes

To get information about Access Control Lists the partner must have one of the following scopes enabled:

• accesscontrol.manage
• accesscontrol.read

Query Arguments

Parameter	Data Type	Description
direction	string	The direction for the Access Control List. Values accepted in this field are: any inbound outbound undirected
partner_sid	string	The partner secure ID.
trunk_group_sid	string	The trunk group secure ID.
trunk_sid	string	The trunk secure ID.

Look Up Effective ACLs for SMS

This request returns the list of effective Access Control Lists (ACLs) for SMS for the partner, targeted by secure ID.

get	/accesscontrol/effective_acl/sms

Sample

A sample GET request to get effective ACLs for SMS:

curl -X GET \
'https://api.carrierx.com/core/v2/accesscontrol/effective_acl/sms' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of Access Control List objects:

{
    "count": 1,
    "has_more": false,
    "items": [
        {
            "effective_acls": [
                {
                    "access_control_rules": [
                        "93525bae-f9a9-446b-b92a-7f421df7a11e"
                    ],
                    "direction": "outbound",
                    "sms_action_false": null,
                    "sms_action_true": "accept",
                    "voice_action_false": null,
                    "voice_action_true": null
                }
            ],
            "layer": 1
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {},
    "total": 1
}

note

Note that effective ACLs are executed from the most top-level object.

This request is enabled for Field Filtering. Additionally, query arguments are used to narrow the results.

Required Scopes

To get information about Access Control Lists the partner must have one of the following scopes enabled:

• accesscontrol.manage
• accesscontrol.read

Query Arguments

Parameter	Data Type	Description
direction	string	The direction for the Access Control List. Values accepted in this field are: any inbound outbound undirected
partner_sid	string	The partner secure ID.