REST API Reference

• Introduction

Overview

• API Basics
• Query String Filters
• Sending data in HTTP
• Rate Limits
• JSON Schema

Authentication

• Authentication Token Operations
• Account API Authentication
• Basic Auth
• IP Authentication
• Authenticating Requests
• Multi Factor Auth
• Scope Restrictions
• Token Authentication
• Token Restrictions
• User Authentication

Realtime Events

• Websockets
• Email Notifications Template

Webhooks

• Webhooks

Account Actions and Permissions

• Accounts
• Security Configuration
• Access Lists
• Alerts
• IPs
• Registrations
• Apps Store
• Comments
• Configs
• Contact List
• Lists
• Migrations
• Search
• Storage
• SUP Over API
• About
• Apps Link

Devices and Users

• Devices
• KAZOO Endpoints
• Groups
• Number Port Requests
• Resource Selectors
• Resource Templates
• Resources
• Users

Media

• Media
• Mms

Call Control

• Callflows
• Limits
• Allotments
• Menus
• Configuring Conferences
• Conference Authentication
• Pivot API
• Functions
• Faxes
• Faxboxes
• Call Channels
• Cccps
• Presence
• Blacklists
• Call Inspector
• Dialplans
• Directories
• Metaflows
• Call Recordings
• Sms
• Temporal Rules
• Temporal Rules Sets
• Voicemail
• Hotdesks
• Parked Calls Slots
• Quickcall

Usage

• Services
• 402 Payment Required
• Braintree
• Call Detail Records
• Ledgers
• Phone Numbers API
• Call Rates
• Transactions
• Connectivity
• Attachment Handlers Errors
• Click To Call

SysAdmin

• System Configs
• System Status
• Tasks - Background Jobs
• Whitelabeling
• Acls
• SUP-able functions
• configuration
• rate-limiting
• reverse-proxy
• Setup SSL support for Crossbar
• HTTP Storage Backend