Jump to Content
Guides
API Reference
v2.0
Log In
API Reference
Log In
v2.0
Guides
API Reference
Mobile/Web Messaging
All
Pages
Start typing to search…
JUMP TO
OneCloud UCaaS API v2
Authentication/Access Token (Oauth - Username/Password)
Get Access Token From Refresh
post
Get Access Token From User/Pass
post
Get Access Token after MFA request
post
Authentication/API Key (Machine 2 Machine)
Read API Keys under your account
get
Read API Key info on your API Key
get
Create API Key
post
Update API Key
put
Revoke API Key
del
Read Info on specific APIKey via Key ID
get
Authentication/JWT (JSON Web Token)
Create JWT token From User/Pass
post
Revoke current JWT
del
Read Current JWT
get
Create JWT token after MFA request
post
Create JWT token For Delegated Access
post
Revoke JWT(s) by UID (user@domain)
del
Revoke JWT by JTI (JWT ID)
del
Event Subscriptions
Read Event Subscriptions
get
Create a Event Subscription
post
Read Event Subscription By Id
get
Update an Event Subscription
put
Delete a subscription
del
Resellers
Get Resellers
get
Create Reseller
post
Update Reseller
put
Delete Reseller
del
Get Specific Reseller
get
Domains
Get Domains
get
Create a Domain
post
Count Domains
get
Get Specific Domain
get
Update a Domain
put
Delete a Domain
del
Get Specific Domain With Billing Summary
get
Get My Domain Info
get
Check if Domain Exists
get
Phone Numbers
Get All Phone Numbers for System or Reseller
get
Get All Phone Numbers for Domain
get
Add Phone Number in Domain
post
Remove Phone Number from Domain
del
Update Phone Number in Domain
put
Get Specific Phone Number in Domain
get
Phone Numbers/Use Cases
Send Phonenumber to Call Queue
put
Send Phonenumber to a User
put
Send Phonenumber to Offnet Number
put
Move phonenumber back to Available in Inventory
put
Users
Search for Users in Domain
get
Create User in Domain
post
Count users in Domain
get
Delete User in Domain
del
Update a User in Domain
put
Get Specific User in Domain
get
Get My User
get
Devices
Get Devices for User
get
Create Device for User
post
Update Device for User
put
Delete Device for User
del
Get Specifc Device
get
Phones/Macs
Read Mac Addresses
get
Add MAC address
post
Update MAC address
put
Remove MAC address
del
Read Mac Addresses in Domain
get
Add MAC address for Domain
post
Update MAC address in Domain
put
Remove MAC address in Domain
del
Read Specific Mac Address
get
Phones/Macs/Supported Models and Servers
Get list of Supported/Provisionable Models
get
Get list of Supported/Provisionable by Vendor
get
Get details of Specific Model
get
Get list of Provisionable Server Profiles
get
Read Provisionable Server Details
get
Sites
Read Sites in Domain
get
Create Site in Domain
post
Update Site in Domain
put
Read Specific Site in Domain
get
Call Center/Callqueues
Read Call Queues in Domain
get
Create Call Queue in Domain
post
Update Call Queue in Domain
put
Delete Call Queue
del
Read Specific Call Queue
get
Call Center/Agents
Read Agents in Call Queue
get
Add Agent to Call Queue
post
Read Agents in Domain
get
Read Specific Agent in Call Queue
get
Update Agent in Call Queue
put
Remove Agent from Call Queue
del
Call Center/Agent Actions
Agent Login
patch
Agent Logout
patch
Agent Single Call
patch
Agent Set Offline Status
patch
Timeframe
Read Timeframes for a User
get
Create Timeframe for a User
post
Read Timeframes for a Domain (Shared)
get
Create Timeframe for a Domain (Shared)
post
Update Timeframe for a User
put
Delete Timeframe for a User
del
Read Specific Timeframe for a User
get
Update Timeframe for a Domain (Shared)
put
Delete Timeframe for a Domain (Shared)
del
Read Specific Timeframe for a Domain (Shared)
get
Answer Rules
Read Answerrules for a User
get
Add a Answerrule for a User
post
Read Answerrules for my User
get
Read Specifc Timeframe Answerrule for User
get
Delete a Answerrule for a User
del
Update a Answerrule for a User
put
Reorder Answerrules for my User
put
Auto Attendant
Create Auto Attendant
post
Read Auto Attendants
get
Read Specific Auto Attendant
get
Update Specific Auto Attendant
put
Media/Voicemail
Read Voicemail for User by Folder
get
Read Specific Voicemail for User
get
Delete Voicemail
del
Move Voicemail to save folder
patch
Forward Voicemail to another user
patch
Media/Greetings
Read Greetings for User
get
Create a new Greeting from TTS
post
Read Specific Greeting for User
get
Delete Specific Greeting for User
del
Update Greeting with TTS script
put
Create a new Greeting from Upload (JSON + Base64 File)
post
Update Greeting from Upload (JSON + Base64 File)
put
Create a new Greeting from Upload (Multipart/Mixed Post)
post
Update Greeting from Upload (Multipart/Mixed Post)
put
Media/Music on Hold/Domain
Read MOH for Domain
get
Create a new MOH for Domain from TTS
post
Update MOH for Domain from TTS
put
Delete MOH for Domain
del
Create a new MOH for Domain from Upload (JSON + Base64 File)
post
Update MOH for Domain from Upload (JSON + Base64 File)
put
Create a new MOH for Domain from Upload (Multipart/Mixed Post)
post
Update MOH for Domain from Upload (Multipart/Mixed Post)
put
Media/Music on Hold/User
Read MOH for User
get
Create a new MOH for Domain from TTS
post
Create a new MOH for User from Upload (JSON + Base64 File)
post
Update MOH for User from Upload (JSON + Base64 File)
put
Update MOH for Domain from TTS
put
Delete MOH for User
del
Create a new MOH for User from Upload (Multipart/Mixed Post)
post
Update a MOH for User from Upload (Multipart/Mixed Post)
put
Media/Hold Messages/Domain
Read Hold Messages for Domain
get
Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
post
Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
put
Delete Hold Messge for Domain
del
Media/Hold Messages/User
Read Hold Messages for User
get
Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
post
Update Hold Messge for User from Upload (Multipart/Mixed Post)
put
Delete Hold Messge for User
del
Media/Text to Speech
Get Available Voices
get
Synthesize Voice (Text to Speech)
post
Synthesize Voice (Text to Speech) via GET
get
CDR (Call History)
Read CDRs
get
Read CDRs for Domain
get
Read CDRs for Specific User
get
Search CDRs for Domain
get
Read CDRs for Site in Domain
get
Count CDRs and SUM minutes
get
Count CDRs and SUM minutes for Domain
get
Count CDRs and SUM minutes for Specifc User
get
Call Traces & Cradle to Grave
Get Call Trace (SIPFlow) For Call
get
Get Cradle to Grave Info For Call
get
Get CSV of call trace For Call
get
Calls (live/active calls)
Read Active Calls In Domain
get
Count Active Calls In Domain
get
Read Active Calls for User
get
Make a new Call
post
Read Specific Actice Call
get
Disconnect Call
del
Transfer Call
patch
Answer Call
patch
Hold Active Call
patch
Un-Hold Active Call
patch
Contacts
Get Contacts for User
get
Create Contact
post
Get Specific Contact for User
get
Update Contact
put
Delete Contact
del
Count Contacts for User
get
Get My Contacts
get
Contacts/Shared Contacts
Get Domain Contacts
get
Create Shared Contact
post
Get Specific Domain Contact
get
Update Shared Contact
put
Delete Shared Contact
del
Addresses
Get Addresses for Domain
get
Create Address for Domain
post
Validate Address
post
Update Address for Domain
put
Delete Address For Domain
del
Update Address for User
put
Get Address Using Address ID
get
Update Address Endpoint
put
Delete Address Endpoint
del
Create Address for User
post
Get Addresses for User
get
Delete Address For User
del
Create Address Endpoint
post
Get Address Endpoints for a Domain
get
Get Addresses Count for Domain
get
Voicemail Reminders
Get Voicemail Reminders for Specific User
get
Delete Voicemail Reminders for Specific User
del
Create Voicemail Reminder
post
Update Voicemail Reminders for Specific User
put
Dialrule
Read Dialrules in a Dialplan
get
Add a new dial rule into a dial plan
post
Read Specific Dialrule in a Dialplan
get
Update a dial rule by ID in a dial plan
put
Delete a dial rule by ID in a dial plan
del
Messages
Get Messagesessions for User
get
Get Messages for Messagesession
get
Send a message (Chat)
post
Send a message (Group Chat)
post
Send a message (Media Chat)
post
Send a message (SMS)
post
Send a message (Group SMS)
post
Send a message (MMS)
post
Update Messagesession (Participants)
put
Delete Messagesession
del
Update Messagesession (Session Name)
put
Update Messagesession (Leave)
put
SMS Numbers
Get All SMS Numbers for System
get
Get SMS Numbers for Domain
get
Create SMS Number
post
Update SMS Number Copy
put
Delete an SMS Number
del
Get SMS Numbers for User
get
Count SMS Numbers for User
get
Recordings
Get Specific Recording as a Party
get
Get Specific Recording as a Non-Party
get
Update Specific Recording
put
Email
Send Email using Template
post
Connections
Get All Connections
get
Create a Connection
post
Count All Conections
get
Get All Connections for a Domain
get
Get Specific Connection for a Domain
get
Delete a Specific Connection for a Domain
del
Update a Connection
put
Routes
Read Routes
get
Create a Route
post
Update A Specific Route
put
Read Route Connections
get
Create a Route Connection
post
Delete A Specific Route
del
Count All Routes
get
Count All Route Connections
get
Update A Specific Route Connection
put
Backup & Restore
Manually Backup a Domain
post
Request a Full System backup
post
Read Available Restore Points
get
Restore a Specifc Domain Backup
put
Configs/Configurations
Read a Specific Configuration
get
Delete a Configuration
del
Read all Configurations
get
Create a Configuration
post
Update a Configuration
put
Configs/Configuration Definitions
Read all Configuration Definitions
get
Create a Configuration Definition
post
Read a Specific Configuration Definition
get
Update a Configuration Definition
put
Delete Configuration Definition
del
Images
Read Image
get
Create Image from Upload (JSON + Base64 File)
post
Delete an Image
del
Update Image from Upload (Multipart/Mixed Post)
put
Update Image from Upload (JSON + Base64 File)
put
Templates
Read Template
get
Create Template from Upload (JSON + Base64 File)
post
Delete a Template
del
Update Template from Upload (JSON + Base64 File)
put
Call Center/QueuedCalls
Read Queued Calls
get
SecureFax API
Email
Send Welcome Email
post
Fax Portal
Fax Send Fax
post
Fax Download
get
Fax Get Faxes
get
Fax Delete
del
Fax Update
post
Get Status
get
Get Number
get
Get User Info
get
Migrate Account
post
Inbound Migrate Account
post
Resend Fax
get
Get Cdr
get
Add Contact
put
Get Contacts
post
Delete Contact
del
Update Contact
patch
Fax Admin
Get Logs
get
HTTPS Fax
Sending a fax via HTTPS (tiff image)
post
Download a fax
get
OneCloud CX
Authentication
Get Access Token
post
Users
Create User
post
Get User Data
get
Update User
put
Delete User
del
Get User Lock State
get
Clear User Lock State
put
Get Teams
get
Users SCIM Provisioning
Create User
post
Get User by userName
get
Get User by ID
get
Replace User Properties (by replacing all existing attributes with a specified set of replacement attributes)
put
Delete User
del
Update User (updates only the properties indicated in the specified set)
patch
Phones
Get Directory
get
Get Access Numbers
get
Regular Call Recordings
Get Regular Recording Audio File
get
Erase Call Recordings
del
Get Interaction Metadata
get
Multichannel Call Recordings
Get Multichannel Recording Structure
get
Get Multichannel Recording Segment Audio File
get
SMS/MMS Messaging
Send Message
post
Get Message
get
Real-Time Statistics
Create Subscription
post
Get Subscription Data
get
Delete Subscription
del
Get Dispositions
get
Get Available Agents
get
Get Teams
get
Mobile/Web Messaging
Check Availability
get
Expected Parameters
get
Request Chat
post
Mobile Notification Subscription
post
Get Active Chat
get
Send Events
post
Get New Chat Events
get
Get Chat History
get
Upload File
post
Get File
get
Get Agent Profile Photo
get
Get ICE servers
get
Get Chat Widget Configuration
get
Get Case History
get
Close Case
post
Get Version
get
Calling List
Add Many Records
post
Add Record
post
Delete All Records
post
Get All Records
post
Get Updated Records
post
Query a Record
post
Update Record
post
Campaigns
Get Campaigns
get
Do Not Call List
Add Records to DNC
post
Replace Records in DNC
post
Delete All Records
post
Delete Records
post
Powered by
Mobile/Web Messaging
Ask AI
