/
NS
ns-api
/
NetSapiens API v2
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 3w ago · Updated 3w ago
d37f65b5b886
latest
OpenAPI 3.1.0
2026-07-24
317
91
1.4 MB
Addresses
15
get
Get Addresses for Domain
post
Create Address for Domain
post
Validate Address
put
Update Address for Domain
delete
Delete Address For Domain
get
Get Address Using Address ID
put
Update Address for User
put
Update Address Endpoint
delete
Delete Address Endpoint
get
Get Addresses for User
post
Create Address for User
delete
Delete Address For User
get
Get Address Endpoints for a Domain
post
Create Address Endpoint
get
Get Addresses Count for Domain
Answer Rules
7
get
Read Answerrules for a User
post
Add a Answerrule for a User
get
Read Answerrules for my User
get
Read Specifc Timeframe Answerrule for User
put
Update a Answerrule for a User
delete
Delete a Answerrule for a User
put
Reorder Answerrules for my User
Authentication/Access Token (Oauth - Username/Password)
3
post
Get Access Token From Refresh
post
Get Access Token From User/Pass
post
Get Access Token after MFA request
Authentication/API Key (Machine 2 Machine)
6
get
Read API Keys under your account
get
Read API Key info on your API Key
post
Create API Key
get
Read Info on specific APIKey via Key ID
put
Update API Key
delete
Revoke API Key
Authentication/JWT (JSON Web Token)
8
get
Read Current JWT
post
Create JWT token From User/Pass
delete
Revoke current JWT
post
Create JWT token after MFA request
post
Create JWT token For Delegated Access
delete
Revoke JWT(s) by UID (user@domain)
delete
Revoke JWT by JTI (JWT ID)
post
Create JWT token from Refresh JWT
Auto Attendant
4
get
Read Auto Attendants
post
Create Auto Attendant
get
Read Specific Auto Attendant
put
Update Specific Auto Attendant
Backup & Restore
4
post
Manually Backup a Domain
post
Request a Full System backup
get
Read Available Restore Points
put
Restore a Specifc Domain Backup
Call Blocking
6
get
Read blocked numbers for a Domain
post
Add blocked numbers for a Domain
delete
Delete blocked numbers for a Domain
get
Read blocked numbers for a User
post
Add blocked numbers for a User
delete
Delete blocked numbers for a User
Call Center/Agent Actions
4
patch
Agent Login
patch
Agent Logout
patch
Agent Single Call
patch
Agent Set Offline Status
Call Center/Agents
6
get
Read Agents in Call Queue
post
Add Agent to Call Queue
get
Read Agents in Domain
get
Read Specific Agent in Call Queue
put
Update Agent in Call Queue
delete
Remove Agent from Call Queue
Call Center/Callqueues
5
get
Read Call Queues in Domain
post
Create Call Queue in Domain
get
Read Specific Call Queue
put
Update Call Queue in Domain
delete
Delete Call Queue
Call Center/QueuedCalls
1
get
Read Queued Calls
Call Traces & Cradle to Grave
3
get
Get Call Trace (SIPFlow) For Call
get
Get Cradle to Grave Info For Call
get
Get CSV of call trace For Call
Calls (live/active calls)
11
get
Read Active Calls In Domain
get
Count Active Calls In Domain
get
Read Active Calls for User
post
Make a new Call
get
Read Specific Actice Call
delete
Disconnect Call
patch
Transfer Call
patch
Answer Call
patch
Hold Active Call
patch
Un-Hold Active Call
delete
Reject Call
CDR (Call History)
8
get
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
Configs/Configuration Definitions
5
get
Read all Configuration Definitions
post
Create a Configuration Definition
get
Read a Specific Configuration Definition
put
Update a Configuration Definition
delete
Delete Configuration Definition
Configs/Configurations
5
get
Read a Specific Configuration
delete
Delete a Configuration
get
Read all Configurations
put
Update a Configuration
post
Create a Configuration
Connections
7
get
Get All Connections
post
Create a Connection
get
Count All Conections
get
Get All Connections for a Domain
get
Get Specific Connection for a Domain
put
Update a Connection
delete
Delete a Specific Connection for a Domain
Contacts
7
get
Get Contacts for User
post
Create Contact
get
Get Specific Contact for User
put
Update Contact
delete
Delete Contact
get
Count Contacts for User
get
Get My Contacts
Contacts/Shared Contacts
5
get
Get Domain Contacts
post
Create Shared Contact
get
Get Specific Domain Contact
put
Update Shared Contact
delete
Delete Shared Contact
Devices
6
get
Get Devices for User
post
Create Device for User
get
Get Specifc Device
put
Update Device for User
delete
Delete Device for User
get
Count Devices for User
Dialrule
5
get
Read Dialrules in a Dialplan
post
Add a new dial rule into a dial plan
get
Read Specific Dialrule in a Dialplan
put
Update a dial rule by ID in a dial plan
delete
Delete a dial rule by ID in a dial plan
Domains
9
get
Get Domains
post
Create a Domain
get
Count Domains
get
Get Specific Domain
put
Update a Domain
delete
Delete a Domain
get
Get Specific Domain With Billing Summary
get
Get My Domain Info
get
Check if Domain Exists
Email
1
post
Send Email using Template
Event Subscriptions
5
get
Read Event Subscriptions
post
Create a Event Subscription
get
Read Event Subscription By Id
put
Update an Event Subscription
delete
Delete a subscription
Firebase
2
get
Read firebase service accounts
post
Add firebase service account
Images
6
get
Read Image
put
Update Image from Upload (Multipart/Mixed Post)
post
Create Image from Upload (JSON + Base64 File)
delete
Delete an Image
put
Update Image from Upload (JSON + Base64 File)
post
Create Image from Upload (Multipart/Mixed Post)
Media/Greetings
9
get
Read Greetings for User
post
Create a new Greeting from TTS
get
Read Specific Greeting for User
put
Update Greeting with TTS script
delete
Delete Specific Greeting for User
post
Create a new Greeting from Upload (JSON + Base64 File)
put
Update Greeting from Upload (JSON + Base64 File)
post
Create a new Greeting from Upload (Multipart/Mixed Post)
put
Update Greeting from Upload (Multipart/Mixed Post)
Media/Hold Messages/Domain
5
get
Read Hold Messages for Domain
post
Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
put
Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
delete
Delete Hold Messge for Domain
get
Count Hold Messages for Domain
Media/Hold Messages/User
4
get
Count Hold Messages for User
post
Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
put
Update Hold Messge for User from Upload (Multipart/Mixed Post)
delete
Delete Hold Messge for User
Media/Music on Hold/Domain
9
get
Read MOH for Domain
post
Create a new MOH for Domain from TTS
put
Update MOH for Domain from TTS
delete
Delete MOH for Domain
get
Count MOH for Domain
post
Create a new MOH for Domain from Upload (JSON + Base64 File)
put
Update MOH for Domain from Upload (JSON + Base64 File)
post
Create a new MOH for Domain from Upload (Multipart/Mixed Post)
put
Update MOH for Domain from Upload (Multipart/Mixed Post)
Media/Music on Hold/User
9
get
Read MOH for User
post
Create a new MOH for Domain from TTS
post
Create a new MOH for User from Upload (JSON + Base64 File)
get
Count MOH for User
put
Update MOH for User from Upload (JSON + Base64 File)
put
Update MOH for Domain from TTS
delete
Delete MOH for User
post
Create a new MOH for User from Upload (Multipart/Mixed Post)
put
Update a MOH for User from Upload (Multipart/Mixed Post)
Media/Text to Speech
3
get
Get Available Voices
get
Synthesize Voice (Text to Speech) via GET
post
Synthesize Voice (Text to Speech)
Media/Voicemail
6
get
Read Voicemail for User by Folder
get
Read Specific Voicemail for User
delete
Delete Voicemail
get
Count Voicemail for User by Folder
patch
Move Voicemail to save folder
patch
Forward Voicemail to another user
Meetings
10
get
Read Meeting
post
Create a Meeting with Id
get
Read Meetings for User
post
Create a Meeting
get
Count Domains Meetings
get
Count Meeting
post
Register Meeting
put
Update a Meeting
delete
Delete a Meeting
post
Request a Meeting ID
Meetings/Event Logs
2
get
Read Meeting Events
post
Create a Meeting Log Event
Meetings/Iotum
9
get
Read Iotum Video Host
get
Read Iotum Video Company
get
Read Iotum Video Host Contacts
get
Read Iotum Video Company Products
get
Read Iotum Video Available Products
get
Read Iotum Video Host Conferences
post
Create a Ad-hoc Conference
get
Read Iotum Video Domain Resellers
get
Read All Iotum Video Hosts in a Domain
Messages
14
get
Get Messagesessions for User
get
Get Messages for Messagesession
post
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)
put
Update Messagesession (Participants)
delete
Delete Messagesession
put
Update Messagesession (Session Name)
put
Update Messagesession (Leave)
get
Get Messagesessions for Domain
post
Start a new Message Session
Phone Numbers
7
get
Get All Phone Numbers for System or Reseller
get
Get All Phone Numbers for Domain
post
Add Phone Number in Domain
get
Get Specific Phone Number in Domain
put
Update Phone Number in Domain
delete
Remove Phone Number from Domain
get
Count Phone Numbers for Domain
Phone Numbers/Use Cases
4
put
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
Phones/Macs
10
get
Read Mac Addresses
put
Update MAC address
post
Add MAC address
delete
Remove MAC address
get
Read Mac Addresses in Domain
put
Update MAC address in Domain
post
Add MAC address for Domain
delete
Remove MAC address in Domain
get
Count Mac Addresses
get
Read Specific Mac Address
Phones/Macs/Supported Models and Servers
5
get
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
Recordings
2
get
Get Specific Recording by Callid for User
get
Get Specific Recording by Callid for Domain
Resellers
5
get
Get Resellers
post
Create Reseller
get
Get Specific Reseller
put
Update Reseller
delete
Delete Reseller
Routes
10
get
Read Routes
put
Update A Specific Route
post
Create a Route
delete
Delete A Specific Route
get
Read Route Connections
put
Update A Specific Route Connection
post
Create a Route Connection
delete
Delete A Specific Route connection
get
Count All Routes
get
Count All Route Connections
Sites
6
get
Read Sites in Domain
post
Create Site in Domain
get
Read Specific Site in Domain
put
Update Site in Domain
get
Count Sites in Domain
get
List Sites in Domain
SMS Numbers
7
get
Get All SMS Numbers for System
get
Get SMS Numbers for Domain
post
Create SMS Number
put
Update SMS Number
delete
Delete an SMS Number
get
Get SMS Numbers for User
get
Count SMS Numbers for User
SSL Certificates
5
get
Read SSL certificates for CertManager
post
Create SSL certificate for CertManager
get
Read SSL certificate by Common Name
put
Update SSL certificate for CertManager
delete
Delete SSL certificate for CertManager
Templates
4
get
Read Template
put
Update Template from Upload (JSON + Base64 File)
post
Create Template from Upload (JSON + Base64 File)
delete
Delete a Template
Timeframes/Holiday Information
3
get
Read Holiday Information by Country
get
Read List of Supported Countries
get
Read List of Supported Regions
Transcriptions & Sentiment
1
get
Read Transcription for Specific Call
Users
8
get
Get Users in Domain
post
Create User in Domain
get
Count users in Domain
get
Search for Users in Domain
get
Get Specific User in Domain
put
Update a User in Domain
delete
Delete User in Domain
get
Get My User
Version
1
get
Read API Version
Voicemail Reminders
5
get
Get Voicemail Reminders for Specific User
put
Update Voicemail Reminders for Specific User
post
Create Voicemail Reminder
delete
Delete Voicemail Reminders for Specific User
get
Count Voicemail Reminders for Specific User
Version
Read API Version
get
/version
Response
object
required
apiversion
string
required
The version the API is currently running
hostname
string
required
The hostname of the server connected to