Jump to Content
Home
Guides
API Reference
Changelog
Discussions
v44.0
v44.1
v44.2
v44.3
v44.4
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v44.3
Home
Guides
API Reference
Changelog
Discussions
Create Reseller
Search
JUMP TO
NetSapiens API v2
Version
Read API Version
get
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
delete
Read Info on specific APIKey via Key ID
get
Authentication/JWT (JSON Web Token)
Create JWT token From User/Pass
post
Revoke current JWT
delete
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)
delete
Revoke JWT by JTI (JWT ID)
delete
Create JWT token from Refresh JWT
post
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
delete
Resellers
Get Resellers
get
Create Reseller
post
Update Reseller
put
Delete Reseller
delete
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
delete
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
delete
Update Phone Number in Domain
put
Get Specific Phone Number in Domain
get
Count Phone Numbers for 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
Get Users in Domain
get
Create User in Domain
post
Count users in Domain
get
Search for Users in Domain
get
Delete User in Domain
delete
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
delete
Get Specifc Device
get
Count Devices for User
get
Phones/Macs
Read Mac Addresses
get
Add MAC address
post
Update MAC address
put
Remove MAC address
delete
Read Mac Addresses in Domain
get
Add MAC address for Domain
post
Update MAC address in Domain
put
Remove MAC address in Domain
delete
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
List Sites 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
delete
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
delete
Call Center/Agent Actions
Agent Login
patch
Agent Logout
patch
Agent Single Call
patch
Agent Set Offline Status
patch
Call Center/QueuedCalls
Read Queued Calls
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
delete
Update a Answerrule for a User
put
Reorder Answerrules for my User
put
Call Blocking
Read blocked numbers for a Domain
get
Add blocked numbers for a Domain
post
Delete blocked numbers for a Domain
delete
Read blocked numbers for a User
get
Add blocked numbers for a User
post
Delete blocked numbers for a User
delete
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
delete
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
delete
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
delete
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
delete
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
delete
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
delete
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
Transcriptions & Sentiment
Read Transcription for Specific Call
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
delete
Transfer Call
patch
Answer Call
patch
Hold Active Call
patch
Un-Hold Active Call
patch
Reject Call
delete
Contacts
Get Contacts for User
get
Create Contact
post
Get Specific Contact for User
get
Update Contact
put
Delete Contact
delete
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
delete
Addresses
Get Addresses for Domain
get
Create Address for Domain
post
Validate Address
post
Update Address for Domain
put
Delete Address For Domain
delete
Update Address for User
put
Get Address Using Address ID
get
Update Address Endpoint
put
Delete Address Endpoint
delete
Create Address for User
post
Get Addresses for User
get
Delete Address For User
delete
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
delete
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
delete
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
delete
Update Messagesession (Session Name)
put
Update Messagesession (Leave)
put
Get Messagesessions for Domain
get
Start a new Message Session
post
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
delete
Get SMS Numbers for User
get
Count SMS Numbers for User
get
Recordings
Get Specific Recording by Callid for User
get
Get Specific Recording by Callid for Domain
get
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
delete
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
delete
Count All Routes
get
Count All Route Connections
get
Update A Specific Route Connection
put
Meetings
Create a Meeting with Id
post
Read Meeting
get
Create a Meeting
post
Read Meetings for User
get
Count Domains Meetings
get
Count Meeting
get
Register Meeting
post
Update a Meeting
put
Delete a Meeting
delete
Request a Meeting ID
post
Meetings/Event Logs
Create a Meeting Log Event
post
Read Meeting Events
get
Meetings/Iotum
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
Create a Ad-hoc Conference
post
Read Iotum Video Host Conferences
get
Read Iotum Video Domain Resellers
get
Read All Iotum Video Hosts in a Domain
get
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
delete
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
delete
Images
Read Image
get
Create Image from Upload (JSON + Base64 File)
post
Delete an Image
delete
Update Image from Upload (Multipart/Mixed Post)
put
Create Image from Upload (Multipart/Mixed Post)
post
Update Image from Upload (JSON + Base64 File)
put
Templates
Read Template
get
Create Template from Upload (JSON + Base64 File)
post
Delete a Template
delete
Update Template from Upload (JSON + Base64 File)
put
Timeframes/Domain (Shared)
Read All Timeframes for Domain (Shared)
get
Read Specific Timeframe for Domain (Shared)
get
Delete Specific Timeframe for Domain (Shared)
delete
Convert Timeframe to Another Type
put
Timeframes/Domain (Shared)/Always
Create Always Timeframe
post
Timeframes/Domain (Shared)/Specific Dates
Create Specific Dates Timeframe
post
Create Additional Date Ranges within Specific Dates Timeframe
post
Delete Date Range within Specific Dates Timeframe
delete
Replace All Date Ranges in Specific Dates Timeframe
put
Update Date Ranges within Specific Dates Timeframe
put
Timeframes/Domain (Shared)/Days of Week
Create Days of Week Timeframe
post
Update Days of Week Timeframe
put
Timeframes/Domain (Shared)/Holiday
Create Holidays Timeframe
post
Create Additional Holidays within Holiday Timeframe
post
Delete Holiday within Holiday Timeframe
delete
Update Holidays within Holiday Timeframe
put
Replace All Holidays in Holiday Timeframe
put
Timeframes/Domain (Shared)/Custom
Create Custom Timeframe
post
Create Additional Entries within Custom Timeframe
post
Delete Entry within Custom Timeframe
delete
Update Entries within Custom Timeframe
put
Replace All Entries in Custom Timeframe
put
Timeframes/User
Read All Timeframes for User
get
Delete Specific Timeframe for User
delete
Read Specific Timeframe for User
get
Convert Timeframe to Another Type
put
Timeframes/User/Always
Create Always Timeframe
post
Timeframes/User/Specific Dates
Create Additional Date Ranges within Specific Dates Timeframe
post
Delete Date Range within Specific Dates Timeframe
delete
Replace All Date Ranges in Specific Dates Timeframe
put
Create Specific Dates Timeframe
post
Update Date Ranges within Specific Dates Timeframe
put
Timeframes/User/Days of Week
Create Days of Week Timeframe
post
Update Days of Week Timeframe
put
Timeframes/User/Holiday
Update Holidays within Holiday Timeframe
put
Create Additional Holidays within Holiday Timeframe
post
Delete Holiday within Holiday Timeframe
delete
Create Holidays Timeframe
post
Replace All Holidays in Holiday Timeframe
put
Timeframes/User/Custom
Create Additional Entries within Custom Timeframe
post
Delete Entry within Custom Timeframe
delete
Create Custom Timeframe
post
Update Entries within Custom Timeframe
put
Replace All Entries in Custom Timeframe
put
Timeframes/Holiday Information
Read Holiday Information by Country
get
Read List of Supported Countries
get
Read List of Supported Regions
get
Read Holiday Information by Country and Region
get
Firebase
Read firebase service accounts
get
Add firebase service account
post
SSL Certificates
Read SSL certificates for CertManager
get
Create SSL certificate for CertManager
post
Read SSL certificate by Common Name
get
Update SSL certificate for CertManager
put
Delete SSL certificate for CertManager
delete
Powered by
Create Reseller
post
https://{server}/ns-api/v2/resellers
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
Bearer
URL
Base URL
https://
ns-api.com
/ns-api/v2
/resellers
RESPONSE
Click
Try It!
to start a request and see the response here!
