Skip to content
Cordboard Documentation
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
0 to carrier in 3 minutes
SIP Interoperability
vsscli Essentials
Namespace Configuration
Namespace Overview
Translation Contexts
Call-Detail Enrichment
Special Number Profiles
Caller-ID Contexts
Screening Contexts
Routes
Feature Code Maps
Namespace Resources
Lines
Line Profiles
Trunks
Trunk Profiles
Voicemail Contexts
Voicemail Boxes
Ring Groups
Namespace Profiles
Namespace Linkages
System Management
RBAC & Authentication
User Administration
Configuration Versioning & Lifecycle
Managing Configuration Versions
LCR Deck Administration
Namespace & Tenant Administration
Resource Management
Voicemail Box Management
Voicemail Administration
Line Feature Management
Device Credentials
Managed-Mode Resources
Logging & Observability
How CDRs Work
Managing CDRs
How Routing Logs Work
Managing Routing Logs
Appendix B: API Reference
Overview
account
Overview
API-key login
Password login (namespace-scoped)
Complete 2FA login (namespace-scoped)
Password login (partition-scoped)
Complete 2FA login (partition-scoped)
Get current user
Change own password
Begin TOTP enrollment
Verify and finalize TOTP enrollment
Cancel a pending TOTP enrollment
Remove own TOTP
List a user's API keys
Create (or replace) an API key
Delete an API key
namespaces
Overview
Create namespace
Get namespace metadata
Delete namespace (cascade)
Clear in-progress call-tracking rows (debug-only)
Get resource authority mode
Get parent namespace
Get direct child namespaces
Get full descendant tree
List all namespaces in partition
config
Overview
List config versions
Store new config version
Validate config against namespace context
Validate config text (no namespace context)
Get a config version
Apply RFC 6902 patch to a config version
Apply config version
Set version tag
Clear version tag
Set version description
peers
Overview
Set or revoke a SIP peer password
Generate random SIP peer password
voicemail
Overview
List all active voicemail boxes
List active boxes in a context
Get active box detail
List messages in active box
Download message audio
Delete message
Download greeting audio
Upload greeting audio (max 25 MiB)
Delete greeting
Set box PIN
Reset box PIN
Set box options (merge-patch)
Wipe all messages from box
Repair box (reconcile counts, delete orphan objects)
List orphan voicemail boxes
Purge all orphan boxes (requires ?confirm=<nsid>)
Purge a single orphan box
List orphan box messages
Download orphan message audio
Delete orphan message
Move orphan box messages to an active box
lines
Overview
List all lines and their features
Get a line's features
Clear all line features (reset to defaults)
Set Do Not Disturb
Set call forward
Clear call forward
Set caller ID blocking
List speed dials
Set speed dial
Delete speed dial
Set multiple line options (merge-patch)
resources
Overview
List managed line definitions
Bulk upsert/delete managed lines
Get managed line definition
Create/replace managed line definition
Delete managed line definition
Merge-patch managed line definition
List managed devices
Bulk upsert/delete managed devices
Get managed device
Create/replace managed device
Delete managed device
List managed trunks
Get managed trunk
Create/replace managed trunk
Delete managed trunk
List managed ring groups
Get managed ring group
Create/replace managed ring group
Delete managed ring group
List managed VM box definitions
Bulk upsert managed VM box definitions
Get managed VM box definition
Create/replace managed VM box definition
Delete managed VM box definition
List managed linkages
Bulk upsert/delete managed linkages
Get managed linkage
Create/replace managed linkage
Delete managed linkage
Merge-patch managed linkage
lcr
Overview
List LCR tables
Get LCR table detail (with version history)
Delete LCR table
Get single LCR route
Upsert single LCR route
Delete single LCR route
Bulk replace table (CSV or JSON)
Bulk patch table (CSV or JSON, upsert/delete rows)
List upload sessions
Open upload session
Get upload session
Abort upload session
Append rows to upload session (CSV or JSON)
Commit upload session
List table versions
Activate a version
Delete old table versions
List routes by trunk (reverse index)
Delete all routes for a trunk
Preview route lookup
Resolve call routing
cdr
Overview
List CDR calls
Delete CDR range (requires confirmation)
List CDR legs (flat)
Get CDR record
List CDR calls (partition-wide)
Delete CDR range (partition-wide, requires confirmation)
List CDR legs (partition-wide)
List CDR download sessions
Open CDR download session
Get download session
Abort download session
Stream next chunk (NDJSON or CSV)
List CDR download sessions (partition-wide)
Open CDR download session (partition-wide)
Get download session (partition-wide)
Abort download session (partition-wide)
Stream next chunk (partition-wide)
route-logs
Overview
List route forensic log records
Delete route log range (requires confirmation)
Get route log detail (with trace)
Select theme
Dark
Light
Auto
Overview
peers
Section titled “peers”
SIP peer credential management (HA1 digest).
Operations
Section titled “Operations”
PUT
/v1/peer/{peer}/setpass
POST
/v1/peer/{peer}/setpass
