For AI agents: visit https://docs.ns-api.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog Discussions

Log In

API Reference

Log In

Home Guides API Reference Changelog Discussions

NetSapiens API v2

Version
Authentication/Access Token (Oauth - Username/Password)
Authentication/API Key (Machine 2 Machine)
Authentication/JWT (JSON Web Token)
Event Subscriptions
Resellers
Domains
Phone Numbers
Phone Numbers/Use Cases
Users
Devices
Phones/Macs
Phones/Macs/Supported Models and Servers
Sites
Call Center/Callqueues
Call Center/Agents
Call Center/Agent Actions
Call Center/QueuedCalls
- Read Queued Callsget
- Add a Queued Callpost
Answer Rules
Call Blocking
Auto Attendant
Media/Voicemail
Media/Greetings
Media/Music on Hold/Domain
Media/Music on Hold/User
Media/Hold Messages/Domain
Media/Hold Messages/User
Media/Text to Speech
CDR (Call History)
Transcriptions & Sentiment
- Read Transcription for Specific Callget
Call Traces & Cradle to Grave
Calls (live/active calls)
Contacts
Contacts/Shared Contacts
Addresses
Voicemail Reminders
Dialrule
Messages
SMS Numbers
Recordings
- Get Specific Recording by Callid for Userget
- Get Specific Recording by Callid for Domainget
Connections
Routes
Meetings
Meetings/Event Logs
- Create a Meeting Log Eventpost
- Read Meeting Eventsget
Meetings/Iotum
Backup & Restore
Configs/Configurations
Configs/Configuration Definitions
Images
Templates
Timeframes/Domain (Shared)
Timeframes/Domain (Shared)/Always
- Create Always Timeframepost
Timeframes/Domain (Shared)/Specific Dates
Timeframes/Domain (Shared)/Days of Week
- Create Days of Week Timeframepost
- Update Days of Week Timeframeput
Timeframes/Domain (Shared)/Holiday
Timeframes/Domain (Shared)/Custom
Timeframes/User
Timeframes/User/Always
- Create Always Timeframepost
Timeframes/User/Specific Dates
Timeframes/User/Days of Week
- Create Days of Week Timeframepost
- Update Days of Week Timeframeput
Timeframes/User/Holiday
Timeframes/User/Custom
Timeframes/Holiday Information
Firebase
- Read firebase service accountsget
- Add firebase service accountpost
SSL Certificates
CDR (Call History)
Email
- Send Email using Templatepost
- Verify Emailpost
Version
- Read API Version get
Phones/Macs/Phone Configurations
Call Center/Statistics
Call Center/Call Dispositions
CDR Schedule
Dial Permisions
Configs/Configurations/NS Configs
iNSight
- Query Data from iNSightget
Conference/Conferences
Conference/Participants
SnapBuilder
Charts
- Get Chart Listget
- Count Chartsget
Dashboards
- Count Dashboards for a Userget
- Get Dashboard List for a Userget
Quotas
Departments
- List Departments in a Domainget
Presence
- List Presence in a Domainget
- List Presence in a Departmentget
SnapBuilder/Phone Templates
Audit Log
- Read Audit Logget
Access Log
- Read Accesslogget
Messages/SMS Block

Powered by

Version

Updated 12 months ago

Authentication/Access Token (Oauth - Username/Password)

Did this page help you?

Updated 12 months ago

Authentication/Access Token (Oauth - Username/Password)

Did this page help you?