For AI agents: visit https://docs.ns-api.com/v45.0/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
netsapiens-api
HomeGuidesAPI ReferenceChangelogDiscussions
Log Innetsapiens-api
API Reference
Log In
HomeGuidesAPI ReferenceChangelogDiscussions

NetSapiens API v2

  • Version
  • Authentication/Access Token (Oauth - Username/Password)
    • Get Access Token From Refreshpost
    • Get Access Token after MFA request Copypost
    • Get Access Token after MFA requestpost
    • Get Access Token From Auth Codepost
    • SSO Enrollpost
  • Authentication/API Key (Machine 2 Machine)
    • Read API Keys under your accountget
    • Read API Key info on your API Keyget
    • Create API Keypost
    • Update API Keyput
    • Revoke API Keydel
    • Read Info on specific APIKey via Key IDget
  • Authentication/JWT (JSON Web Token)
    • Create JWT token From User/Passpost
    • Revoke current JWT del
    • Read Current JWTget
    • Create JWT token after MFA requestpost
    • Create JWT token For Delegated Accesspost
    • Revoke JWT(s) by UID (user@domain)del
    • Revoke JWT by JTI (JWT ID)del
    • Create JWT token from Refresh JWTpost
  • Event Subscriptions
    • Read Event Subscriptionsget
    • Create a Event Subscriptionpost
    • Read Event Subscription By Idget
    • Update an Event Subscriptionput
    • Delete a subscriptiondel
    • Read Event Subscriptions for Domainget
    • Update an Event Subscription for Domainput
    • Delete a subscription For Domaindel
    • Create a Event Subscription for Domainpost
  • Resellers
    • Get Resellersget
    • Create Resellerpost
    • Update Resellerput
    • Delete Resellerdel
    • Get Specific Resellerget
    • Count Resellersget
  • Domains
    • Get Domains get
    • Create a Domainpost
    • Count Domainsget
    • Get Specific Domainget
    • Update a Domainput
    • Delete a Domaindel
    • Get Specific Domain With Billing Summaryget
    • Get My Domain Infoget
    • Check if Domain Existsget
  • Phone Numbers
    • Get All Phone Numbers for System or Resellerget
    • Get All Phone Numbers for Domainget
    • Add Phone Number in Domainpost
    • Remove Phone Number from Domaindel
    • Update Phone Number in Domainput
    • Get Specific Phone Number in Domainget
    • Count Phone Numbers for Domainget
    • Count All Phone Numbers for System or Resellerget
  • Phone Numbers/Use Cases
    • Send Phonenumber to Call Queueput
    • Send Phonenumber to a User put
    • Send Phonenumber to Offnet Numberput
    • Move phonenumber back to Available in Inventoryput
  • Users
    • Get Users in Domainget
    • Create User in Domainpost
    • Count users in Domainget
    • Search for Users in Domainget
    • Delete User in Domaindel
    • Update a User in Domainput
    • Get Specific User in Domainget
    • Get My User get
    • List Basic Info on Users in Domainget
  • Devices
    • Get Devices for Userget
    • Create Device for Userpost
    • Update Device for Userput
    • Delete Device for Userdel
    • Get Specifc Deviceget
    • Count Devices for Userget
    • Count Devices for Domainget
    • Count Devices for Resellerget
    • Count Devices by Deviceget
    • Get Devices in Domainget
  • Phones/Macs
    • Read Mac Addressesget
    • Add MAC addresspost
    • Update MAC addressput
    • Remove MAC addressdel
    • Read Mac Addresses in Domainget
    • Add MAC address for Domainpost
    • Update MAC address in Domainput
    • Remove MAC address in Domaindel
    • Read Specific Mac Addressget
    • Count Mac Addressesget
    • Read Specific Mac Addresses in Domainget
  • Phones/Macs/Supported Models and Servers
    • Get list of Supported/Provisionable Modelsget
    • Get list of Supported/Provisionable by Vendorget
    • Get details of Specific Modelget
    • Get list of Provisionable Server Profilesget
    • Read Provisionable Server Detailsget
  • Sites
    • Read Sites in Domainget
    • Create Site in Domainpost
    • Update Site in Domainput
    • Read Specific Site in Domainget
    • List Sites in Domainget
    • Count Sites in Domainget
  • Call Center/Callqueues
    • Read Call Queues in Domainget
    • Create Call Queue in Domainpost
    • Update Call Queue in Domainput
    • Delete Call Queuedel
    • Read Specific Call Queueget
    • Read Basic info on Call Queues in Domainget
  • Call Center/Agents
    • Read Agents in Call Queueget
    • Add Agent to Call Queuepost
    • Read Agents in Domainget
    • Read Specific Agent in Call Queueget
    • Update Agent in Call Queueput
    • Remove Agent from Call Queuedel
    • Count Agents in Call Queueget
  • Call Center/Agent Actions
    • Agent Login patch
    • Agent Logoutpatch
    • Agent Single Callpatch
    • Agent Set Offline Statuspatch
  • Call Center/QueuedCalls
    • Read Queued Callsget
    • Add a Queued Callpost
  • Answer Rules
    • Read Answerrules for a Userget
    • Add a Answerrule for a Userpost
    • Read Answerrules for my Userget
    • Read Specifc Timeframe Answerrule for Userget
    • Delete a Answerrule for a User del
    • Update a Answerrule for a Userput
    • Reorder Answerrules for my Userput
    • Count Answerrules for a Userget
  • Call Blocking
    • Read blocked numbers for a Domainget
    • Add blocked numbers for a Domainpost
    • Delete blocked numbers for a Domaindel
    • Read blocked numbers for a Userget
    • Add blocked numbers for a Userpost
    • Delete blocked numbers for a Userdel
  • Auto Attendant
    • Create Auto Attendantpost
    • Read Auto Attendantsget
    • Read Specific Auto Attendantget
    • Update Specific Auto Attendantput
    • Delete Specific Auto Attendantdel
  • Media/Voicemail
    • Read Voicemail for User by Folderget
    • Read Specific Voicemail for User get
    • Delete Voicemail del
    • Move Voicemail to save folderpatch
    • Forward Voicemail to another userpatch
    • Count Voicemail for User by Folderget
  • Media/Greetings
    • Read Greetings for Userget
    • Create a new Greeting from TTSpost
    • Read Specific Greeting for Userget
    • Delete Specific Greeting for Userdel
    • Update Greeting with TTS scriptput
    • 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
    • Count Greetings for Userget
  • Media/Music on Hold/Domain
    • Read MOH for Domainget
    • Create a new MOH for Domain from TTSpost
    • Update MOH for Domain from TTSput
    • Delete MOH for Domaindel
    • 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
    • Count MOH for Domainget
  • Media/Music on Hold/User
    • Read MOH for Userget
    • Create a new MOH for Domain from TTSpost
    • 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 TTSput
    • 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
    • Count MOH for Userget
  • Media/Hold Messages/Domain
    • Read Hold Messages for Domainget
    • 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 Domaindel
    • Count Hold Messages for Domainget
  • Media/Hold Messages/User
    • Read Hold Messages for Userget
    • 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
    • Count Hold Messages for Userget
  • Media/Text to Speech
    • Get Available Voicesget
    • Synthesize Voice (Text to Speech) post
    • Synthesize Voice (Text to Speech) via GETget
  • CDR (Call History)
  • Transcriptions & Sentiment
    • Read Transcription for Specific Callget
  • Call Traces & Cradle to Grave
    • Get Call Trace (SIPFlow) For Callget
    • Get Cradle to Grave Info For Callget
    • Get CSV of call trace For Callget
  • Calls (live/active calls)
    • Read Active Calls In Domainget
    • Count Active Calls In Domainget
    • Read Active Calls for Userget
    • Make a new Callpost
    • Read Specific Active Callget
    • Disconnect Calldel
    • Transfer Callpatch
    • Answer Callpatch
    • Hold Active Callpatch
    • Un-Hold Active Callpatch
    • Reject Calldel
    • Transfer Peer Callpatch
    • Report Active Callspost
  • Contacts
    • Get Contacts for Userget
    • Create Contactpost
    • Get Specific Contact for Userget
    • Update Contactput
    • Delete Contactdel
    • Count Contacts for Userget
    • Get My Contactsget
  • Contacts/Shared Contacts
    • Get Domain Contactsget
    • Create Shared Contactpost
    • Get Specific Domain Contactget
    • Update Shared Contactput
    • Delete Shared Contactdel
  • Addresses
    • Get Addresses for Domainget
    • Create Address for Domainpost
    • Validate Addresspost
    • Update Address for Domainput
    • Delete Address For Domaindel
    • Update Address for Userput
    • Get Address Using Address IDget
    • Update Address Endpointput
    • Delete Address Endpointdel
    • Create Address for Userpost
    • Get Addresses for Userget
    • Delete Address For Userdel
    • Create Address Endpointpost
    • Get Address Endpoints for a Domainget
    • Get Addresses Count for Domainget
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific Userget
    • Delete Voicemail Reminders for Specific Userdel
    • Create Voicemail Reminderpost
    • Update Voicemail Reminders for Specific Userput
    • Count Voicemail Reminders for Specific Userget
  • Dialrule
    • Read Dialrules in a Dialplanget
    • Add a new dial rule into a dial planpost
    • Read Specific Dialrule in a Dialplanget
    • Update a dial rule by ID in a dial planput
    • Delete a dial rule by ID in a dial plandel
    • Count Dialrules in a Dialplanget
    • Read Dialplansget
    • Create Dialplan Globalpost
    • Create Dialplan for Domainpost
    • Update Dialplan for Domainput
    • Delete Dialplan for Domaindel
  • Messages
    • Get Messagesessions for Userget
    • Get Messages for Messagesessionget
    • 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 Messagesessiondel
    • Update Messagesession (Session Name)put
    • Update Messagesession (Leave)put
    • Get Messagesessions for Domainget
    • Start a new Message Sessionpost
    • Get Messagesession for Userget
  • SMS Numbers
    • Get All SMS Numbers for Systemget
    • Get SMS Numbers for Domainget
    • Create SMS Numberpost
    • Update SMS Numberput
    • Delete an SMS Numberdel
    • Get SMS Numbers for Userget
    • Count SMS Numbers for Userget
  • Recordings
    • Get Specific Recording by Callid for Userget
    • Get Specific Recording by Callid for Domainget
  • Connections
    • Get All Connectionsget
    • Create a Connectionpost
    • Count All Conectionsget
    • Get All Connections for a Domainget
    • Update a Connectionput
    • Get Specific Connection for a Domainget
    • Delete a Specific Connection for a Domaindel
  • Routes
    • Read Routesget
    • Create a Routepost
    • Delete A Specific Routedel
    • Count All Routesget
    • Count All Route Connectionsget
    • Read Route Connections for Routeget
    • Create a Route Connectionpost
    • Update A Specific Routeput
    • Update A Specific Route Connectionput
    • Delete A Specific Route connectiondel
  • Meetings
    • Create a Meeting with Idpost
    • Read Meetingget
    • Create a Meetingpost
    • Read Meetings for Userget
    • Count Domains Meetingsget
    • Count Meetingget
    • Register Meetingpost
    • Update a Meetingput
    • Delete a Meetingdel
    • Request a Meeting IDpost
  • Meetings/Event Logs
    • Create a Meeting Log Eventpost
    • Read Meeting Eventsget
  • Meetings/Iotum
    • Read Iotum Video Hostget
    • Read Iotum Video Companyget
    • Read Iotum Video Host Contactsget
    • Read Iotum Video Company Productsget
    • Read Iotum Video Available Productsget
    • Create a Ad-hoc Conferencepost
    • Read Iotum Video Host Conferencesget
    • Read Iotum Video Domain Resellersget
    • Read All Iotum Video Hosts in a Domainget
    • Update Domain's Iotum Companyput
    • Create Iotum Video Companypost
    • Delete a Video Companydel
    • Create a Hostpost
    • Update User's Iotum Hostput
    • Delete a Hostdel
    • Create Host Contactspost
    • Create Iotum Video Subscriptionpost
    • Delete Iotum Video Subscriptiondel
    • Update Domain's Iotum Subscriptionsput
  • Backup & Restore
    • Manually Backup a Domainpost
    • Request a Full System backuppost
    • Read Available Restore Pointsget
    • Restore a Specifc Domain Backupput
  • Configs/Configurations
    • Read a Specific Configurationget
    • Delete a Configurationdel
    • Read all Configurationsget
    • Create a Configurationpost
    • Update a Configurationput
    • Count Configurationsget
  • Configs/Configuration Definitions
    • Read all Configuration Definitionsget
    • Create a Configuration Definitionpost
    • Read a Specific Configuration Definitionget
    • Update a Configuration Definitionput
    • Delete Configuration Definitiondel
  • Images
    • Read Imageget
    • Create Image from Upload (JSON + Base64 File)post
    • Delete an Imagedel
    • 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 Templateget
    • Create Template from Upload (JSON + Base64 File)post
    • Delete a Templatedel
    • 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)del
    • Convert Timeframe to Another Typeput
  • Timeframes/Domain (Shared)/Always
    • Create Always Timeframepost
  • Timeframes/Domain (Shared)/Specific Dates
    • Create Specific Dates Timeframepost
    • Create Additional Date Ranges within Specific Dates Timeframepost
    • Delete Date Range within Specific Dates Timeframedel
    • Replace All Date Ranges in Specific Dates Timeframeput
    • Update Date Ranges within Specific Dates Timeframeput
  • Timeframes/Domain (Shared)/Days of Week
    • Create Days of Week Timeframepost
    • Update Days of Week Timeframeput
  • Timeframes/Domain (Shared)/Holiday
    • Create Holidays Timeframepost
    • Create Additional Holidays within Holiday Timeframepost
    • Delete Holiday within Holiday Timeframedel
    • Update Holidays within Holiday Timeframeput
    • Replace All Holidays in Holiday Timeframeput
  • Timeframes/Domain (Shared)/Custom
    • Create Custom Timeframepost
    • Create Additional Entries within Custom Timeframepost
    • Delete Entry within Custom Timeframedel
    • Update Entries within Custom Timeframeput
    • Replace All Entries in Custom Timeframeput
  • Timeframes/User
    • Read All Timeframes for Userget
    • Delete Specific Timeframe for Userdel
    • Read Specific Timeframe for Userget
    • Convert Timeframe to Another Typeput
    • Delete All Timeframes for Userdel
  • Timeframes/User/Always
    • Create Always Timeframepost
  • Timeframes/User/Specific Dates
    • Create Additional Date Ranges within Specific Dates Timeframepost
    • Delete Date Range within Specific Dates Timeframedel
    • Replace All Date Ranges in Specific Dates Timeframeput
    • Create Specific Dates Timeframepost
    • Update Date Ranges within Specific Dates Timeframeput
  • Timeframes/User/Days of Week
    • Create Days of Week Timeframepost
    • Update Days of Week Timeframeput
  • Timeframes/User/Holiday
    • Update Holidays within Holiday Timeframeput
    • Create Additional Holidays within Holiday Timeframepost
    • Delete Holiday within Holiday Timeframedel
    • Create Holidays Timeframepost
    • Replace All Holidays in Holiday Timeframeput
  • Timeframes/User/Custom
    • Create Additional Entries within Custom Timeframepost
    • Delete Entry within Custom Timeframedel
    • Create Custom Timeframepost
    • Update Entries within Custom Timeframeput
    • Replace All Entries in Custom Timeframeput
  • Timeframes/Holiday Information
    • Read Holiday Information by Countryget
    • Read List of Supported Countriesget
    • Read List of Supported Regionsget
    • Read Holiday Information by Country and Regionget
  • Firebase
    • Read firebase service accountsget
    • Add firebase service accountpost
  • SSL Certificates
    • Read SSL certificates for CertManagerget
    • Create SSL certificate for CertManagerpost
    • Read SSL certificate by Common Nameget
    • Update SSL certificate for CertManagerput
    • Delete SSL certificate for CertManagerdel
  • CDR (Call History)
    • Read CDRsget
    • Read CDRs for Domainget
    • Read CDRs for Specific Userget
    • Search CDRs for Domainget
    • Read CDRs for Site in Domainget
    • Count CDRs and SUM minutesget
    • Count CDRs and SUM minutes for Domainget
    • Count CDRs and SUM minutes for Specifc Userget
  • Email
    • Send Email using Templatepost
    • Verify Emailpost
  • Version
    • Read API Version get
  • Phones/Macs/Phone Configurations
  • Call Center/Statistics
    • Get Callqueue Statistics for a Specific Queueget
    • Get Callqueue Statistics for all Queues Aggregatedget
    • Get Agent Statistics for all Queues by Agentget
    • Get Agent Statistics for Single Queues by Agentget
    • Get Agent Statistics for Single Agentget
    • Get DNIS Statistics for all Queuesget
    • Get DNIS Statistics for Single Queueget
    • Get Agent Logget
    • Get Abandoned Calls for all Queuesget
    • Get Abandoned Calls for a Specific Queueget
    • Get Callqueue Statistics for all Queues by Queueget
  • Call Center/Call Dispositions
  • CDR Schedule
    • Count CDR Schedules for Domainget
    • Count CDR Schedules for Resellerget
    • Count CDR Schedules by Nameget
  • Dial Permisions
    • Read Policiesget
    • Create Dialpolicy Tablepost
    • Read Specific Policyget
    • Update Dialpolicy put
    • Delete Dialpolicy del
    • Read Permissions in a DialPolicyget
    • Add a new permission to a dialpolicy tablepost
    • Read Specific Permission in a Dialpolicyget
    • Update a permission in a dialpolicy tableput
    • Delete a permission by ID in a dialpolicydel
    • Read Specific Policy in Domainget
    • Update Dialpolicy in Domainput
    • Delete Dialpolicy in Domaindel
    • Read Permissions in a DialPolicy in Domainget
    • Add a new permission to a dialpolicy table in Domainpost
    • Read Specific Permission in a Dialpolicy in Domainget
    • Update a permission in a dialpolicy table in Domainput
    • Delete a permission by ID in a dialpolicy in Domaindel
  • Configs/Configurations/NS Configs
  • iNSight
    • Query Data from iNSightget
  • Conference/Conferences
    • Get Conferences in Domainget
    • Create Conference for Domainpost
    • Count Conferences in Domainget
    • Get Conference CDR from Domainget
    • Update Conference in Domainput
    • Delete Conference in Domaindel
    • Get Conference in Domainget
  • Conference/Participants
    • Get Participants from Conferenceget
    • Create Participant for Conferencepost
    • Update Participant for Conferenceput
    • Delete Participant from Conferencedel
  • SnapBuilder
    • Read Device Profilesget
    • Get specific Device Profile for Model of Phoneget
    • Count Device Profilesget
    • Get Phone Configuration for specific Macget
    • Count Phone Configurationsget
    • Update Phone Configuration for Specific Mac Addressput
    • Delete Phone Configuration for Specific Mac Addressdel
    • Create Phone Configuration for Specific Mac Addresspost
  • Charts
    • Get Chart Listget
    • Count Chartsget
  • Dashboards
    • Count Dashboards for a Userget
    • Get Dashboard List for a Userget
  • Quotas
    • Count Quotas for Domainget
    • Get Quota for Domainget
    • Get Quota for Domains in Resellerget
    • Count Quotas for Resellerget
  • Departments
    • List Departments in a Domainget
  • Presence
    • List Presence in a Domainget
    • List Presence in a Departmentget
  • SnapBuilder/Phone Templates
    • Read Phone Templates available to a Domainget
    • Create Phone Template in domainpost
    • Read Specific Phone Templates by name get
    • Update Phone Template in domainput
    • Delete Phone Template in domaindel
    • Count Phone Templates for a Domainget
  • Audit Log
    • Read Audit Logget
  • Access Log
    • Read Accesslogget
  • Messages/SMS Block
    • Read SMS Blocks for Domainget
    • Add SMS Blocks for Domainpost
    • Read SMS Blocks for all Domainsget
    • Update SMS Block for Domainput
    • Delete/Deactivate SMS Block for Domaindel
Powered by 

Phones/Macs/Phone Configurations

Updated 11 months ago


Read API Version
Call Center/Statistics
Did this page help you?

Updated 11 months ago


Read API Version
Call Center/Statistics
Did this page help you?