NetSapiens API v2

NetSapiens API v2

Authentication
- Access Token (Oauth - Username/Password)
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- NetsapiensJs Auth
- Masquerade
Phone Numbers
- destination-application mappings and parameter parsing
- Use Cases
- Count Phone Numbers for Domain
  GET
- Get All Phone Numbers for System or Reseller
  GET
- Count 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
Phones/Macs
- Supported Models and Servers
- Phone Configurations
- Read Mac Addresses
- Count Mac Addresses
- Read Mac Addresses in Domain
- Read Specific Mac Address
- Read Specific Mac Addresses in Domain
- Add MAC address
- Add MAC address for Domain
- Update MAC address
- Update MAC address in Domain
- Remove MAC address
- Remove MAC address in Domain
SnapBuilder
- Phone Templates
- Read Device Profiles
- Count Device Profiles
- Get specific Device Profile for Model of Phone
- Count Phone Configurations in a Domain
- Get Phone Configuration for specific Mac
- Create Phone Configuration for Specific Mac Address
- Update Phone Configuration for Specific Mac Address
- Delete Phone Configuration for Specific Mac Address
Version
- Read API Version
Event Subscriptions
- Read Event Subscriptions
- Read Event Subscriptions for Domain
- Read Event Subscription By Id
- Create a Event Subscription
- Update an Event Subscription
- Update an Event Subscription for Domain
- Delete a subscription
- Delete a subscription For Domain
- Create a Event Subscription for Domain
Resellers
- Get Resellers
- Count Resellers
- Create Reseller
- Update Reseller
- Delete Reseller
- Get Specific Reseller
Domains
- Get Domains
- Count Domains
- Get Specific Domain
- Get Specific Domain With Billing Summary
- Get My Domain Info
- Check if Domain Exists
- Create a Domain
- Update a Domain
- Delete a Domain
Users
- Get Users in Domain
- Count users in Domain
- Search for Users in Domain
- Create User in Domain
- Delete User in Domain
- Update a User in Domain
- Get Specific User in Domain
- Get My User
- List Basic Info on Users in Domain
Devices
- Get Devices for User
- Count Devices for Domain
- Count Devices for Reseller
- Count Devices for User
- Count Devices by Device
- Create Device for User
- Update Device for User
- Delete Device for User
- Get Specifc Device
- Get Devices in Domain
- Get Devices for Reseller or System Wide
Sites
- List Sites in Domain
- Read Sites in Domain
- Count Sites in Domain
- Create Site in Domain
- Update Site in Domain
- Read Specific Site in Domain
Call Center
- Callqueues
- Agents
- Agent Actions
- QueuedCalls
  - Read Queued Calls
  - Add a Queued Call
- Statistics
- Call Dispositions
  - Read Call Dispostions
  - Create Call Disposition in Domain
Answer Rules
- Read Answerrules for a User
- Count Answerrules for a User
- Read Answerrules for my User
- Read Specifc Timeframe Answerrule for User
- Add a Answerrule for a User
- Delete a Answerrule for a User
- Update a Answerrule for a User
- Reorder Answerrules for my User
Call Blocking
- Read blocked numbers for a Domain
- Read blocked numbers for a User
- Add blocked numbers for a Domain
- Add blocked numbers for a User
- Delete blocked numbers for a Domain
- Delete blocked numbers for a User
Auto Attendant
- Create Auto Attendant
- Read Auto Attendants
- Read Specific Auto Attendant
- Update Specific Auto Attendant
- Delete Specific Auto Attendant
Media
- Voicemail
- Greetings
- Music on Hold
  - Domain
  - User
- Hold Messages
  - Domain
  - User
- Text to Speech
CDR (Call History)
- Read CDRs
- Read CDRs for Domain
- Read CDRs for Specific User
- Search CDRs for Domain
- Read CDRs for Site in Domain
- Count CDRs and SUM minutes
- Count CDRs and SUM minutes for Domain
- Count CDRs and SUM minutes for Specifc User
CDR Schedule
- Count CDR Schedules for Domain
- Count CDR Schedules for Reseller
- Count CDR Schedules by Name
Call Traces & Cradle to Grave
- Get Call Trace (SIPFlow) For Call
- Get Cradle to Grave Info For Call
- Get CSV of call trace For Call
Transcriptions & Sentiment
- Read Transcription for Specific Call
Calls (live/active calls)
- Read Active Calls In Domain
- Count Active Calls In Domain
- Read Active Calls for User
- Read Specific Active Call
- Make a new Call
- Make a new Call to Record File
- Disconnect Call
- Transfer Peer Call
- Transfer Call
- Answer Call
- Hold Active Call
- Un-Hold Active Call
- Reject Call
- Report Active Calls
Contacts
- Shared Contacts
- Get List of Contacts Groups for User
- Get Contacts for User
- Get Specific Contact for User
- Count Contacts for User
- Create Contact
- Update Contact
- Delete Contact
- Get My Contacts
Addresses
- Get Addresses for Domain
- Validate Address
- Create Address for Domain
- Update Address for Domain
- Update Address for User
- Update Address Endpoint
- Create Address for User
- Delete Address For User
- Delete Address Endpoint
- Delete Address For Domain
- Create Address Endpoint
- Get Address Endpoints for a Domain
- Get Addresses Count for Domain
- Get Addresses for User
- Get Address Using Address ID
Voicemail Reminders
- Get Voicemail Reminders for Specific User
- Count Voicemail Reminders for Specific User
- Delete Voicemail Reminders for Specific User
- Create Voicemail Reminder
- Update Voicemail Reminders for Specific User
Dialrule
- Read Dialrules in a Dialplan
- Count Dialrules in a Dialplan
- Read Specific Dialrule in a Dialplan
- Add a new dial rule into a dial plan
- Update a dial rule by ID in a dial plan
- Delete a dial rule by ID in a dial plan
- Read Dialplans
- Create Dialplan Global
- Create Dialplan for Domain
- Update Dialplan for Domain
- Delete Dialplan for Domain
Dial Permisions
- Read Policies
- Read Specific Policy
- Read Specific Policy in Domain
- Read Permissions in a DialPolicy
- Read Permissions in a DialPolicy in Domain
- Read Specific Permission in a Dialpolicy
- Read Specific Permission in a Dialpolicy in Domain
- Create Dialpolicy Table
- Update Dialpolicy
- Update Dialpolicy in Domain
- Add a new permission to a dialpolicy table
- Add a new permission to a dialpolicy table in Domain
- Update a permission in a dialpolicy table
- Update a permission in a dialpolicy table in Domain
- Delete a permission by ID in a dialpolicy
- Delete a permission by ID in a dialpolicy in Domain
- Delete Dialpolicy
- Delete Dialpolicy in Domain
Messages
- SMS Block
- Get Messagesessions for Domain
- Start a new Message Session
- Get Messagesessions for User
- Get Messages for Messagesession
- Send a message (Chat)
- Send a message (Group Chat)
- Send a message (Media Chat)
- Send a message (SMS)
- Send a message (Group SMS)
- Send a message (MMS)
- Update Messagesession (Participants)
- Update Messagesession (Session Name)
- Update Messagesession (Leave)
- Delete Messagesession
- Add Participant to Messagesession
- Remove Participant from Messagesession
- Create a message session
SMS Numbers
- Get SMS Numbers for Domain Copy
- Get All SMS Numbers for System
- Get SMS Numbers for Domain
- Create SMS Number
- Update SMS Number
- Delete an SMS Number
- Get SMS Numbers for User
- Count SMS Numbers for User
Recordings
- Get Specific Recording by Callid for User
- Get Specific Recording by Callid for Domain
Email
- Validate SMTP creds and Send Test Email
- Send Email using Template
Connections
- Get All Connections
- Count All Conections
- Get All Connections for a Domain
- Get Specific Connection for a Domain
- Delete a Specific Connection for a Domain
- Create a Connection
- Update a Connection
Routes
- Read Routes
- Count All Routes
- Read Route Connections for Route
- Count All Route Connections
- Create a Route
- Create a Route Connection
- Update A Specific Route
- Update A Specific Route Connection
- Delete A Specific Route
- Delete A Specific Route connection
Meetings
- Event Logs
  - Create a Meeting Log Event
  - Read Meeting Events
- Iotum
- Create a Meeting with Id
- Create a Meeting
- Read Meeting
- Count Domains Meetings
- Count Meeting
- Register Meeting
- Update a Meeting
- Delete a Meeting
- Request a Meeting ID
- Read Meetings for User
Backup & Restore
- Manually Backup a Domain
- Request a Full System backup
- Read Available Restore Points
- Restore a Specifc Domain Backup
Configs
- Configurations
- Configuration Definitions
Images
- Read Image
- Create Image from Upload (Multipart/Mixed Post)
- Create Image from Upload (JSON + Base64 File)
- Delete an Image
- Update Image from Upload (Multipart/Mixed Post)
- Update Image from Upload (JSON + Base64 File)
Templates
- Read Template
- Create Template from Upload (Multipart/Mixed Post)
- Create Template from Upload (JSON + Base64 File)
- Delete a Template
- Update Template from Upload (Multipart/Mixed Post)
- Update Template from Upload (JSON + Base64 File)
Timeframes
- Domain (Shared)
- User
- Holiday Information
Firebase
- Read firebase service accounts
- Add firebase service account
SSL Certificates
- Read SSL certificates for CertManager
- Read SSL certificate by Common Name
- Create SSL certificate for CertManager
- Update SSL certificate for CertManager
- Delete SSL certificate for CertManager
Manage Code
- View Servers Available to manage code on
- Read all code packages for all servers in cluster
- Read all package details for a specific server
- Update/Refresh repository info on Server
- View current repos info on Server
- Add repository version to Server
- Remove repository version from Server
- Install/Update a netsapiens package or packages on a specific server
- Prefrom a dist-upgrade on a server updating all existing packages (netsapiens and not) to latest version available
- Cleanup unused packages on a specific server
iNSight
- Query Data from iNSight
- Query Data from iNSight for alerts
- Query Healthcheck Data from iNSight
Conference
- Conferences
- Participants
Charts
- Count Charts
- Get Chart List
Dashboards
- Count Dashboards for a User
- Get Dashboard List for a User
Quotas
- Get Quota for Domain
- Get Quota for Domains in Reseller
- Count Quotas for Domain
- Count Quotas for Reseller
Departments
- List Departments in a Domain
Presence
- List Presence in a Domain
- List Presence in a Department
Audit Log
- Read Audit Log
Access Log
- Read Accesslog
Avatars
- Generic
  - Read Available Generic Avatars
  - Add Avatar for Shared Generic Use
- Add/Update Avatar for User
- Read Meta data Avatar for User
- Delete Avatar for User
- Read Avatars for User
- Count Avatars for User
- Add/Update Avatar for User's Contact
- Add/Update Avatar for Domains's Shared Contact
Brands
- List all Brands (Super User)
- List brands for a reseller (minimal fields)
- Get all brands for a reseller (full data)
- List brands for reseller + hostname (minimal fields)
- Get all brands for reseller + hostname (full data)
- Get a specific brand (full data)
- Get active brand for hostname (full data)
- Create a new brand
- Copy a brand to a new brand-name or hostname
- Update a brand
- Delete a brand
Brand Assets
- Get all assets for a brand
- Get a specific brand asset
- Download brand asset as binary file
- Upload a brand asset (JSON + Base64 File)
- Upload a brand asset (Multipart/Mixed Post)
- Update a brand asset (JSON + Base64 File)
- Update a brand asset (Multipart/Mixed Post)
- Delete a brand asset
Schemas
- Schemas
  - Domain
  - DomainLegacy
  - User
  - UserLegacy
  - Device
  - CallQueue
  - Agent
  - Answerrule
  - AnswerruleFeature
  - AnswerruleFeatureWithRemove
  - AnswerruleFeatureSimRing
  - AnswerruleLegacy
  - Site
  - AuthRequest
  - AuthRequestMFA
  - SSOEnroll
  - CallRequest
  - ActiveCall
  - DialRule
  - Phonenumber
  - Contact
  - Timeframe
  - Timerange
  - AccessToken
  - Address
  - AddressCreateReturn
  - AddressEndpoint
  - AddressValidate
  - Reseller
  - ApiKey
  - Audiofile
  - MediaRequest
  - CdrD
  - CdrU
  - CdrR
  - NdpPhone
  - NdpModel
  - NdpServer
  - Messagesession
  - Message
  - MessageSend
  - SmsNumber
  - Vmailnag
  - DomainBilling
  - Subscription
  - Recording
  - EmailCreate
  - Agentlog
  - DeviceLegacy
  - CallActions
  - TtsVoice
  - AutoAttendant
  - AutoAttendantTier
  - AutoAttendantTierOption
  - Restore
  - BackupResponse
  - Meeting
  - Configuration
  - ConfigDefinition
  - ConnectionExtra
  - Connection
  - DeletegateRequest
  - JwtResponse
  - JwtRequestSuccess
  - Image
  - Template
  - RecurringTimeframe
  - TimeframeSpecificDate
  - TimeframeHoliday
  - TimeframeDOW
  - IotumHost
  - IotumContact
  - RecordingOld
  - CallBlocking
  - Transcription
  - NumberEnabledMap
  - Dialplan
  - Conference
  - ConferenceParticipant
  - ConferenceCDR
  - Chart
  - Dashboard
  - Presence
  - Route
  - RouteConnection
  - PublicUserInfo
  - DispositionReason
  - DeviceModel
  - Holiday
  - Auditlog
  - QueueStat
  - Phoneconfiguration
  - AbandondedCallStat
  - OIDCProvider
  - EmailValidate
  - ErrorResponse
  - CodeApplicationServer
  - CodeApplicationServerDetails
- Enums
  - YesNoString
  - YesNoStringYesDefault
  - YesNoStringNoDefault
  - StringDefaultStar
  - DomainName
  - DomainNamePath
  - UserName
  - UserNamePath
  - SuccessResponse
  - Count
  - TimeZone
  - Scopes
  - SubscriptionModel
  - Synchronous
  - DialruleApplication
  - CallqueuePath
  - AgentPath
  - AutoAttendantFailOptions
  - Timestamp
  - DeleteType
  - OneZeroBoolean
  - OneZeroDefaultOne
  - OneZeroDefaultZero
  - MeetingStatus
  - RecordingConfiguration
  - MessageType
  - MimeTypes
  - StringInteger
  - DatetimeStart
  - DatetimeEnd
  - RecurringTimeframeType
  - RecurringTimeframeHolidayObservance
  - Limit
  - Start
  - Permission
  - Dialpolicy
- securitySchemes
  - ApiKeyAuth
- Certficate
- DeviceProfileButton
- DeviceProfile
- DeviceImage
- DeviceModelButtonType
- InsightValue
- PhoneConfigBtn
- SmsBlock
- Avatar
- EmailTestResponse
- CodeApplication
- RepoRequest
- RepoDetails
- Record not found
- Brand
- Bad Request
- BrandAsset
- Authentication Required

RepoRequest

{
    "hostname": "core1-phx.ca.nseng.dev",
    "maxVersion": "46.0",
    "maxAvailableVersion": "46.0",
    "codename": "noble",
    "repos": []
}