


Create and update access devices, read their lines, files, and tags, and list devices at group, service provider, or system level. Send JSON, get normalized JSON back. Dialplane handles OCI-P rendering, parsing, and release-specific commands.
Ask which users sit on a phone’s lines or which tags a device carries, then let the AI client create or update devices within its token’s scopes. No raw sockets, XML, or unscoped credentials.
The same API provisions users, assigns services and numbers, and configures groups, so a new phone and the user who will use it are created in one session.
MCP tools and REST workflows create, update, list, and read devices today. Items marked rolling out are on their way as dedicated device tools.
Work from an AI client over MCP, or script the same steps over REST. Dialplane checks each request against the token’s scopes before sending it, and BroadWorks keeps it within what the signed-in login can reach.
01
Create the access device with its type and MAC address
02
List the group’s devices to confirm the new one is there
03
Read the device to see which users are on each line and port
04
Check the custom tags, tag set, and files the device serves
05
Update the MAC or net address when the hardware is swapped
06
Read the device back to confirm the change
Scoped tokens. Start with full access for fast setup, then narrow by scopes such as read:device, provision:device, or read:user.
Tenant bounds. Limit a token to specific service providers or groups.
Login-tier policy. Set ceilings per BroadWorks login type and inspect recent scope denies.
Dialplane builds BroadWorks commands from typed schemas and returns typed JSON. Passwords sent to BroadWorks are redacted from logs, and deleting a service provider, group, or reseller is never allowed through the API.
Normalized responses
Typed, camelCase data from BroadWorks OCI responses. Clients never parse XML.
Two interfaces
Provisioning systems and AI clients use the same tenant-safe device API.
Device credentials
A device read reports whether credentials are set, never the device password.