Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Getting Started
  • Choosing the Right API Version
  • Getting Started
  • Architecture
  • Quick Start
  • Authentication
  • Roles and API Access
  • API Categories
  • API Endpoints Reference
  • Making Your First API Call
  • Working with Encrypted Tokens
  • Code Examples
  • Error Handling
  • Best Practices
  • Troubleshooting
  • Support
  1. Getting Started

API Categories

Platform APIs (Module)#

Core platform management APIs organized in subfolders:

Users#

List users with filtering and pagination
Get user details by ID
Create, update, delete users

Groups#

List organizational units (groups)
Get group hierarchy
Create, update, delete groups
Manage group relationships

Webhooks#

List webhooks with filtering
Create webhook subscriptions
Update webhook URLs and settings
Delete webhooks

Media Prompts#

Upload audio recordings (prompts, whispers, voicemails, surveys)
Retrieve recordings with type filtering
Delete recordings (soft delete)

AI Voice Agents#

Manage AI-powered voice agents for call handling:
List voice agents
Create new voice agents with configuration
Retrieve agent details
Update agent settings
Delete agents

SMS Broadcasts#

Campaign management for SMS broadcasts:
Create SMS broadcast campaigns
List broadcasts with filtering
Get broadcast details and status
Update broadcast settings
Schedule broadcasts for future delivery
Cancel scheduled broadcasts

Phone Numbers#

Phone number inventory and provisioning:
Search available phone numbers by area code/region
Assign phone numbers to organizational units
Order new phone numbers
Delete/release phone numbers

Conversations#

Retrieve call and SMS conversation data:
Calls: Get call conversation history with filtering
SMS: Get SMS conversation threads and messages

Provisioned Routes#

Configure call routing rules:
List provisioned routes
Create routing configurations
Update route settings
Delete routes

Miscellaneous#

Utility endpoints for supporting data:
Get industry list
Get ad source list
Tag management (list, create, update, delete)
Modified at 2026-03-23 16:17:18
Previous
Roles and API Access
Next
API Endpoints Reference
Built with