Dialpad
Introduction
API Reference
{{user.name}}
Log In
Introduction
API Reference
Discussions
Home
Introduction
Recipes
API Reference
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Introduction
API Reference
Discussions
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Getting Started
Welcome!
Some Guidelines
Authentication
Authentication Basics
Manual API Key Generation
Token Generation via OAuth
Features
Event Subscriptions
Call Events
SMS Events
Contact Events
App Launch URLs
Dialpad Mini Dialer (CTI)
Call Routing via APIs
Technical Specifications
Rate Limits
A2P Compliance
Getting Started
Welcome!
Some Guidelines
Authentication
Authentication Basics
Manual API Key Generation
Token Generation via OAuth
Features
Event Subscriptions
Call Events
SMS Events
Contact Events
App Launch URLs
Dialpad Mini Dialer (CTI)
Call Routing via APIs
Technical Specifications
Rate Limits
A2P Compliance
api
app
get
Get the app settings
blockednumbers
get
List blocked numbers
post
Add blocked numbers
post
Remove blocked numbers
get
Get blocked number
call
post
Initiate outbound call -- ring device
get
Get Call info
callback
post
Request call back
callcenters
get
Get call center by id
delete
Remove operator
get
Get operators
post
Add operator
callrouters
get
List API call routers
post
Create API call router
delete
Delete API call router by ID
get
Get API call router by ID
patch
Update API call router by ID
post
Assign number
coachingteams
get
Get a coaching team by id
get
Get all members of a coaching team by team id
post
Add a user to the coaching team
company
get
Get company
conference
get
List meeting summaries
get
List conference rooms
contacts
get
List contacts
post
Create contact
put
Create contact with uid
delete
Delete contact by id
get
Get contact by id
patch
Update contact
customivrs
get
Get custom ivrs
patch
Set ivr for a target
departments
get
Get department by id
delete
Remove operator
get
Get operators
post
Add operator
event
get
Get call event subscriptions
delete
Delete call event subscription
get
Get call event subscription
put
Create call event subscription
get
Get contact event subscriptions
delete
Delete contact event subscription
get
Get contact event subscription
put
Create contact event subscription
get
Get SMS event subscriptions
delete
Delete SMS event subscription
get
Get SMS event subscription
put
Create SMS event subscription
numbers
get
Get numbers
post
Assign number
post
E.164 encode and decode
delete
Un-assign number
get
Get details by number
offices
get
Get offices
get
Get office by id
post
Assign number
get
Get office E911 address by office id
put
Update E911 address of the office
get
Get operators
post
Un-assign number
get
Get available licenses
get
Get call centers
get
Get departments
get
Get plan
get
Get all teams of a office by office id
recordingsharelink
post
Create recording share link by id
delete
Delete recording share link by id
get
Get recording share link by id
put
Update recording share link by id
rooms
get
Get rooms
post
Create room
post
Request a PIN to make international calls from rooms
delete
Delete room
get
Get room by id
patch
Update room
post
Assign number
post
Un-assign number
get
Gets desk phones under a room
post
Create room desk phone
delete
Kill desk phone by id
get
Get desk phone by id
sms
post
Sends an SMS message.
stats
post
Process statistics
get
Get statistics results
subscriptions
get
Get agent status event subscriptions
post
Create agent status event subscription
delete
Delete agent status event subscription by id
get
Get agent status event subscription by id
patch
Update agent status event subscription by id
get
Get call event subscriptions
post
Create call event subscription
delete
Delete call event subscription by id
get
Get call event subscription by id
patch
Update call event subscription by id
get
Get contact event subscriptions
post
Create contact event subscription
delete
Delete contact event subscription by id
get
Get contact event subscription by id
patch
Update contact event subscription by id
get
Get SMS event subscriptions
post
Create SMS event subscription
delete
Delete SMS event subscription by id
get
Get SMS event subscription by id
patch
Update SMS event subscription by id
transcripts
get
Get the transcript of a call
get
Get the transcript url of a call
userdevices
get
List the devices for a specific user
get
Get device
users
get
List users
post
Create user
delete
Delete user by id
get
Get user by id
patch
Update user
patch
Toggle live call recording
post
Assign number
get
Get user E911 address by user id
put
Update E911 address of the user
post
Initiate oubound call
patch
Move office by id
get
Personas
post
Initiate screen pop
patch
Toggle live call vi
post
Un-assign number
get
Gets desk phones under a user
post
Create user desk phone
delete
Kill desk phone by id
get
Get desk phone by id
webhooks
get
Get all webhooks
post
Create webhook
delete
Delete webhook by id
get
Get webhook by id
patch
Update webhook by id
Download the API Collection
Powered by