Add trunk IP ACL entry
add_ip_acl_entryAllow-list a public IPv4 address or CIDR range to let static-IP PBX, SBC, or carrier devices use Vobiz trunks without digest credentials. Attach to a trunk via update_sip_trunk.
Instructions
Allow-list a public IPv4 address or CIDR range (e.g. 198.51.100.42 or 10.20.30.0/24) so a static-IP PBX, SBC or carrier can use Vobiz trunks without digest credentials. Attach it to a trunk with update_sip_trunk (ipacl_uuid); for peers on dynamic IPs use create_trunk_credential instead. The server rejects ranges wider than /8, host bits set in a CIDR, and non-unicast or loopback addresses; IPv6 is not accepted. Returns the entry's id. Remove it later with delete_ip_acl_entry. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Label of 1-255 characters, e.g. Office PBX. Returned by Vobiz as `description`. | |
| confirm | Yes | Must be true, set only after the user explicitly approved: allow-listing this IP address for SIP traffic. | |
| ip_address | Yes | Public IPv4 address (198.51.100.42) or IPv4 CIDR network (10.20.30.0/24, prefix 8-32, no host bits). Use the peer's public address, not a NAT-internal one. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| created | No | True when the record was created by this call. | |
| ip_acl_id | No | UUID of the new entry: use it as ipacl_uuid on a trunk. Null if Vobiz did not return one. | |
| http_status | No | HTTP status Vobiz answered with. | |
| ip_acl_entry | No | The entry as Vobiz returned it. |