NetSapiens

Interact with the NetSapiens API

Actions477

Raw Actions
- Raw API Request
Access Log Actions
- Read Accesslog
Addresses Actions
- Create Address Endpoint
- Create Address for Domain
- Create Address for User
- Delete Address Endpoint
- Delete Address for Domain
- Delete Address for User
- Get Address Endpoints for a Domain
- Get Address Using Address ID
- Get Addresses Count for Domain
- Get Addresses for Domain
- Get Addresses for User
- Update Address Endpoint
- Update Address for Domain
- Update Address for User
- Validate Address
Answer Rules Actions
- Add a Answerrule for a User
- Count Answerrules for a User
- Delete a Answerrule for a User
- Read Answerrules for a User
- Read Answerrules for My User
- Read Specifc Timeframe Answerrule for User
- Reorder Answerrules for My User
- Update a Answerrule for a User
Audit Log Actions
- Read Audit Log
Authentication/Access Token (Oauth - Username/Password) Actions
- Get Access Token After MFA Include Passcode
- Get Access Token After MFA Request
- Get Access Token from Auth Code
- Get Access Token from Refresh
- SSO Enroll
Authentication/API Key (Machine 2 Machine) Actions
- Create API Key
- Read API Key Info on Your API Key
- Read API Keys Under Your Account
- Read Info on Specific Apikey Via Key ID
- Revoke API Key
- Update API Key
Authentication/JWT (JSON Web Token) Actions
- Create JWT Token After MFA Request
- Create JWT Token for Delegated Access
- Create JWT Token from Refresh JWT
- Create JWT Token from User/pass
- Read Current JWT
- Revoke Current JWT
- Revoke JWT by JTI (JWT ID)
- Revoke Jwt(s) by UID (user@domain)
- Validate JWT
- Validate JWT Format
Authentication/User Credentials Actions
- Validate
Auto Attendant Actions
- Create Auto Attendant
- Delete Specific Auto Attendant
- Read Auto Attendants
- Read Specific Auto Attendant
- Update Specific Auto Attendant
Backup & Restore Actions
- Manually Backup a Domain
- Read Available Restore Points
- Request a Full System Backup
- Restore a Specifc Domain Backup
Call Blocking Actions
- Add Blocked Numbers for a Domain
- Add Blocked Numbers for a User
- Delete Blocked Numbers for a Domain
- Delete Blocked Numbers for a User
- Read Blocked Numbers for a Domain
- Read Blocked Numbers for a User
Call Center/Agent Actions Actions
- Agent Login
- Agent Logout
- Agent Set Offline Status
- Agent Single Call
Call Center/Agents Actions
- Add Agent to Call Queue
- Count Agents in Call Queue
- Read Agents in Call Queue
- Read Agents in Domain
- Read Specific Agent in Call Queue
- Remove Agent from Call Queue
- Update Agent in Call Queue
Call Center/Callqueues Actions
- Create Call Queue in Domain
- Delete Call Queue
- Read Basic Info on Call Queues in Domain
- Read Call Queues in Domain
- Read Specific Call Queue
- Update Call Queue in Domain
Call Center/QueuedCalls Actions
- Add a Queued Call
- Read Queued Calls
Call Center/Statistics Actions
- Get Abandoned Calls for a Specific Queue
- Get Abandoned Calls for All Queues
- Get Agent Log
- Get Agent Statistics for All Queues by Agent
- Get Agent Statistics for Single Agent
- Get Agent Statistics for Single Queues by Agent
- Get Callqueue Statistics for a Specific Queue
- Get Callqueue Statistics for All Queues Aggregated
- Get Callqueue Statistics for All Queues by Queue
- Get DNIS Statistics for All Queues
- Get DNIS Statistics for Single Queue
Call Traces & Cradle to Grave Actions
- Get Call Trace (sipflow) for Call
- Get Cradle to Grave Info for Call
- Get CSV of Call Trace for Call
Calls (live/active calls) Actions
- Answer Call
- Count Active Calls in Domain
- Disconnect Call
- Hold Active Call
- Make a New Call
- Read Active Calls for User
- Read Active Calls in Domain
- Read Specific Active Call
- Reject Call
- Report Active Calls
- Transfer Call
- Transfer Peer Call
- Un Hold Active Call
CDR (Call History) Actions
- Count Cdrs and SUM Minutes
- Count Cdrs and SUM Minutes for Domain
- Count Cdrs and SUM Minutes for Specifc User
- Read Cdrs
- Read Cdrs for Domain
- Read Cdrs for Site in Domain
- Read Cdrs for Specific User
- Search Cdrs for Domain
CDR Schedule Actions
- Count CDR Schedules by Name
- Count CDR Schedules for Domain
- Count CDR Schedules for Reseller
Charts Actions
- Count Charts
- Get Chart List
Conference/Conferences Actions
- Count Conferences in Domain
- Create Conference for Domain
- Delete Conference in Domain
- Get Conference CDR from Domain
- Get Conference in Domain
- Get Conferences in Domain
- Update Conference in Domain
Conference/Participants Actions
- Create Participant for Conference
- Delete Participant from Conference
- Get Participants from Conference
- Update Participant for Conference
Configs/Configuration Definitions Actions
- Create a Configuration Definition
- Delete Configuration Definition
- Read a Specific Configuration Definition
- Read All Configuration Definitions
- Update a Configuration Definition
Configs/Configurations Actions
- Count Configurations
- Create a Configuration
- Delete a Configuration
- Read a Specific Configuration
- Read All Configurations
- Update a Configuration
Connections (Trunks) Actions
- Count All Conections
- Create a Connection
- Delete a Specific Connection for a Domain
- Get All Connections
- Get All Connections for a Domain
- Get Specific Connection for a Domain
- Update a Connection
Contacts Actions
- Count Contacts for User
- Create Contact
- Delete Contact
- Get Contacts for User
- Get My Contacts
- Get Specific Contact for User
- Update Contact
Contacts/Shared Contacts Actions
- Create Shared Contact
- Delete Shared Contact
- Get Domain Contacts
- Get Specific Domain Contact
- Update Shared Contact
Dashboards Actions
- Count Dashboards for a User
- Get Dashboard List for a User
Departments Actions
- List Departments in a Domain
Devices Actions
- Count Devices by Device
- Count Devices for Domain
- Count Devices for Reseller
- Count Devices for User
- Create Device for User
- Delete Device for User
- Get Devices for User
- Get Devices in Domain
- Get Specifc Device
- Update Device for User
Dial Permisions Actions
- Add a New Permission to a Dialpolicy Table
- Add a New Permission to a Dialpolicy Table in Domain
- Create Dialpolicy Table
- Delete a Permission by ID in a Dialpolicy
- Delete a Permission by ID in a Dialpolicy in Domain
- Delete Dialpolicy
- Delete Dialpolicy in Domain
- Read Permissions in a Dialpolicy
- Read Permissions in a Dialpolicy in Domain
- Read Policies
- Read Specific Permission in a Dialpolicy
- Read Specific Permission in a Dialpolicy in Domain
- Read Specific Policy
- Read Specific Policy in Domain
- Update a Permission in a Dialpolicy Table
- Update a Permission in a Dialpolicy Table in Domain
- Update Dialpolicy
- Update Dialpolicy in Domain
Dialrule Actions
- Add a New Dial Rule Into a Dial Plan
- Count Dialrules in a Dialplan
- Create Dialplan for Domain
- Create Dialplan Global
- Delete a Dial Rule by ID in a Dial Plan
- Delete Dialplan for Domain
- Read Dialplans
- Read Dialrules in a Dialplan
- Read Specific Dialrule in a Dialplan
- Update a Dial Rule by ID in a Dial Plan
- Update Dialplan for Domain
Domains Actions
- Check If Domain Exists
- Count Domains
- Create a Domain
- Delete a Domain
- Get Domains
- Get My Domain Info
- Get Specific Domain
- Get Specific Domain with Billing Summary
- Update a Domain
Email Actions
- Send Email Using Template
- Verify Email
Event Subscriptions Actions
- Create a Event Subscription
- Create a Event Subscription for Domain
- Delete a Subscription
- Delete a Subscription for Domain
- Read Event Subscription by ID
- Read Event Subscriptions
- Read Event Subscriptions for Domain
- Update an Event Subscription
- Update an Event Subscription for Domain
Firebase Actions
- Add Firebase Service Account
- Read Firebase Service Accounts
Images Actions
- Create Image from Upload
- Create Image from Upload (multipart/mixed Post)
- Delete an Image
- Read Image
- Update Image from Upload
iNSight Actions
- Query Data from Insight
Media/Greetings Actions
- Count Greetings for User
- Create a New Greeting from TTS
- Create a New Greeting from Upload
- Delete Specific Greeting for User
- Read Greetings for User
- Read Specific Greeting for User
- Update Greeting from Upload
- Update Greeting with TTS Script
Media/Hold Messages/Domain Actions
- Count Hold Messages for Domain
- Create a New Hold Message for Domain from Upload
- Delete Hold Messge for Domain
- Read Hold Messages for Domain
- Update Hold Message for Domain from Upload
Media/Hold Messages/User Actions
- Count Hold Messages for User
- Create a New Hold Message for User from Upload
- Delete Hold Messge for User
- Read Hold Messages for User
- Update Hold Message for User from Upload
Media/Music on Hold/Domain Actions
- Count MOH for Domain
- Create a New MOH for Domain from TTS
- Create a New MOH for Domain from Upload
- Delete MOH for Domain
- Read MOH for Domain
- Update MOH for Domain from TTS
- Update MOH for Domain from Upload
Media/Music on Hold/User Actions
- Count MOH for User
- Create a New MOH for Domain from TTS
- Create a New MOH for User from Upload
- Delete MOH for User
- Read MOH for User
- Update MOH for Domain from TTS
- Update MOH for User from Upload
Media/Text to Speech Actions
- Get Available Voices
- Synthesize Voice (text to Speech)
- Synthesize Voice (text to Speech) Via GET
Media/Voicemail Actions
- Count Voicemail for User by Folder
- Delete Voicemail
- Forward Voicemail to Another User
- Move Voicemail to Save Folder
- Read Specific Voicemail for User
- Read Voicemail for User by Folder
Meetings Actions
- Count Domains Meetings
- Count Meeting
- Create a Meeting
- Create a Meeting with ID
- Delete a Meeting
- Read Meeting
- Read Meetings for User
- Register Meeting
- Request a Meeting ID
- Update a Meeting
Meetings/Event Logs Actions
- Create a Meeting Log Event
- Read Meeting Events
Meetings/Iotum Actions
- Create a Ad Hoc Conference
- Create a Host
- Create Host Contacts
- Create Iotum Video Company
- Create Iotum Video Subscription
- Delete a Host
- Delete a Video Company
- Delete Iotum Video Subscription
- Read All Iotum Video Hosts in a Domain
- Read Iotum Video Available Products
- Read Iotum Video Company
- Read Iotum Video Company Products
- Read Iotum Video Domain Resellers
- Read Iotum Video Host
- Read Iotum Video Host Conferences
- Read Iotum Video Host Contacts
- Update Domain's Iotum Company
- Update Domain's Iotum Subscriptions
- Update User's Iotum Host
Messages Actions
- Delete Messagesession
- Get Messages for Messagesession
- Get Messagesession for User
- Get Messagesessions for Domain
- Get Messagesessions for User
- Send a Message (chat)
- Send a Message (group Chat)
- Send a Message (group SMS)
- Send a Message (media Chat)
- Send a Message (MMS)
- Send a Message (SMS)
- Start a New Message Session
- Update Messagesession (leave)
- Update Messagesession (participants)
- Update Messagesession (session Name)
Messages/SMS Block Actions
- Add SMS Blocks for Domain
- Delete/deactivate SMS Block for Domain
- Read SMS Blocks for All Domains
- Read SMS Blocks for Domain
- Update SMS Block for Domain
Phone Numbers Actions
- Add Phone Number in Domain
- Count All Phone Numbers for System or Reseller
- Count Phone Numbers for Domain
- Get All Phone Numbers for Domain
- Get All Phone Numbers for System or Reseller
- Get Specific Phone Number in Domain
- Remove Phone Number from Domain
- Update Phone Number in Domain
Phone Numbers/Use Cases Actions
- Move Phonenumber Back to Available in Inventory
- Send Phonenumber to a User
- Send Phonenumber to Call Queue
- Send Phonenumber to Offnet Number
Phones/Macs Actions
- Add MAC Address
- Add MAC Address for Domain
- Count MAC Addresses
- Read MAC Addresses
- Read MAC Addresses in Domain
- Read Specific MAC Address
- Read Specific MAC Addresses in Domain
- Remove MAC Address
- Remove MAC Address in Domain
- Update MAC Address
- Update MAC Address in Domain
Phones/Macs/Supported Models and Servers Actions
- Get Details of Specific Model
- Get List of Provisionable Server Profiles
- Get List of Supported/provisionable by Vendor
- Get List of Supported/provisionable Models
- Read Provisionable Server Details
Presence Actions
- List Presence in a Department
- List Presence in a Domain
Quotas Actions
- Count Quotas for Domain
- Count Quotas for Reseller
- Get Quota for Domain
- Get Quota for Domains in Reseller
Recordings Actions
- Get Specific Recording by Callid for Domain
- Get Specific Recording by Callid for User
Resellers Actions
- Count Resellers
- Create Reseller
- Delete Reseller
- Get Resellers
- Get Specific Reseller
- Update Reseller
Routes Actions
- Count All Route Connections
- Count All Routes
- Create a Route
- Create a Route Connection
- Delete a Specific Route
- Delete a Specific Route Connection
- Read Route Connections for Route
- Read Routes
- Update a Specific Route
- Update a Specific Route Connection
Sites Actions
- Count Sites in Domain
- Create Site in Domain
- List Sites in Domain
- Read Sites in Domain
- Read Specific Site in Domain
- Update Site in Domain
SMS Numbers Actions
- Count SMS Numbers for User
- Create SMS Number
- Delete an SMS Number
- Get All SMS Numbers for System
- Get SMS Numbers for Domain
- Get SMS Numbers for User
- Update SMS Number
SnapBuilder Actions
- Count Device Profiles
- Count Phone Configurations in a Domain
- Create Phone Configuration for Specific MAC Address
- Delete Phone Configuration for Specific MAC Address
- Get Phone Configuration for Specific MAC
- Get Specific Device Profile for Model of Phone
- Read Device Profiles
- Update Phone Configuration for Specific MAC Address
SnapBuilder/Phone Templates Actions
- Count Phone Templates for a Domain
- Create Phone Template in Domain
- Delete Phone Template in Domain
- Read Phone Templates Available to a Domain
- Read Specific Phone Templates by Name
- Update Phone Template in Domain
SSL Certificates Actions
- Create SSL Certificate for Certmanager
- Delete SSL Certificate for Certmanager
- Read SSL Certificate by Common Name
- Read SSL Certificates for Certmanager
- Update SSL Certificate for Certmanager
Templates Actions
- Create Template from Upload (JSON + Base64 File)
- Delete a Template
- Read Template
- Update Template from Upload (JSON + Base64 File)
Timeframes/Domain (Shared) Actions
- Convert Timeframe to Another Type
- Delete Specific Timeframe for Domain (shared)
- Read All Timeframes for Domain (shared)
- Read Specific Timeframe for Domain (shared)
Timeframes/Domain (Shared)/Always Actions
- Create Always Timeframe
Timeframes/Domain (Shared)/Custom Actions
- Create Additional Entries Within Custom Timeframe
- Create Custom Timeframe
- Delete Entry Within Custom Timeframe
- Replace All Entries in Custom Timeframe
- Update Entries Within Custom Timeframe
Timeframes/Domain (Shared)/Days of Week Actions
- Create Days of Week Timeframe
- Update Days of Week Timeframe
Timeframes/Domain (Shared)/Holiday Actions
- Create Additional Holidays Within Holiday Timeframe
- Create Holidays Timeframe
- Delete Holiday Within Holiday Timeframe
- Replace All Holidays in Holiday Timeframe
- Update Holidays Within Holiday Timeframe
Timeframes/Domain (Shared)/Specific Dates Actions
- Create Additional Date Ranges Within Specific Dates Timeframe
- Create Specific Dates Timeframe
- Delete Date Range Within Specific Dates Timeframe
- Replace All Date Ranges in Specific Dates Timeframe
- Update Date Ranges Within Specific Dates Timeframe
Timeframes/Holiday Information Actions
- Read Holiday Information by Country
- Read Holiday Information by Country and Region
- Read List of Supported Countries
- Read List of Supported Regions
Timeframes/User Actions
- Convert Timeframe to Another Type
- Delete All Timeframes for User
- Delete Specific Timeframe for User
- Read All Timeframes for User
- Read Specific Timeframe for User
Timeframes/User/Always Actions
- Create Always Timeframe
Timeframes/User/Custom Actions
- Create Additional Entries Within Custom Timeframe
- Create Custom Timeframe
- Delete Entry Within Custom Timeframe
- Replace All Entries in Custom Timeframe
- Update Entries Within Custom Timeframe
Timeframes/User/Days of Week Actions
- Create Days of Week Timeframe
- Update Days of Week Timeframe
Timeframes/User/Holiday Actions
- Create Additional Holidays Within Holiday Timeframe
- Create Holidays Timeframe
- Delete Holiday Within Holiday Timeframe
- Replace All Holidays in Holiday Timeframe
- Update Holidays Within Holiday Timeframe
Timeframes/User/Specific Dates Actions
- Create Additional Date Ranges Within Specific Dates Timeframe
- Create Specific Dates Timeframe
- Delete Date Range Within Specific Dates Timeframe
- Replace All Date Ranges in Specific Dates Timeframe
- Update Date Ranges Within Specific Dates Timeframe
Transcriptions & Sentiment Actions
- Read Transcription for Specific Call
Users Actions
- Count Users in Domain
- Delete User in Domain
- Get My User
- Get Specific User in Domain
- Get Users in Domain
- List Basic Info on Users in Domain
- Search for Users in Domain
- Update a User in Domain
Version Actions
- Read API Version
Voicemail Reminders Actions
- Count Voicemail Reminders for Specific User
- Create Voicemail Reminder
- Delete Voicemail Reminders for Specific User
- Get Voicemail Reminders for Specific User
- Update Voicemail Reminders for Specific User

Configs/Configuration Definitions → Update a Configuration Definition

AI-generated

Summary

Update a configuration definition by providing its name and body, optionally refreshing cached dropdown options.

Inputs

refreshOptions — Whether to bypass cached dropdown values and fetch fresh options
PutConfigDefinitionsBy__path__config-name (required) —
PutConfigDefinitionsBy__body —

Output shape

the updated configuration definition object

Success response typically returns the modified definition; failures return an error envelope.

Examples

Example 1: Update SMTP host configuration without refreshing dropdowns

refreshOptions: false, PutConfigDefinitionsBy__path__config-name: "smtp_host", PutConfigDefinitionsBy__body: {"host": "mail.example.com"}

Example 2: Force fresh options while updating a domain configuration

refreshOptions: true, PutConfigDefinitionsBy__path__config-name: "domains", PutConfigDefinitionsBy__body: {"newDomain": "test.example.com"}

NetSapiens

Actions477

Configs/Configuration Definitions → Update a Configuration Definition

Summary

Inputs

Output shape

Examples

Example 1: Update SMTP host configuration without refreshing dropdowns

Example 2: Force fresh options while updating a domain configuration

Links

Discussion

NetSapiensInstall

Actions477

Configs/Configuration Definitions → Update a Configuration Definition

Summary

Inputs

Output shape

Examples

Example 1: Update SMTP host configuration without refreshing dropdowns

Example 2: Force fresh options while updating a domain configuration

Links

Discussion

NetSapiens