NetSapiens API v2
  1. Schemas
NetSapiens API v2
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Count All Phone Numbers for System or Reseller
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Phones/Macs
    • Supported Models and Servers
      • Get list of Supported/Provisionable Models
      • Get list of Supported/Provisionable by Vendor
      • Get details of Specific Model
      • Get list of Provisionable Server Profiles
      • Read Provisionable Server Details
    • 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 Phone Templates available to a Domain
      • Read Specific Phone Templates by name
      • Count Phone Templates for a Domain
      • Create Phone Template in domain
      • Update Phone Template in domain
      • Delete Phone Template in domain
    • 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
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
      • Read API Keys under your account
      • Read Info on specific APIKey via Key ID
      • Create API Key
      • Update API Key
      • Revoke API Key
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
      • Revoke current JWT
      • Read Current JWT
    • NetsapiensJs Auth
  • 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
  • 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
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
      • Read Basic info on Call Queues in Domain
    • Agents
      • Read Agents in Call Queue
      • Count Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
      • Add a Queued Call
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
      • Get DNIS Statistics for all Queues
      • Get DNIS Statistics for Single Queue
      • Get Agent Log
      • Send Call Center Email Report
      • Get Abandoned Calls for all Queues
      • Get Abandoned Calls for a Specific Queue
    • 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
      • Read Voicemail for User by Folder
      • Count Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Count Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Count MOH for Domain
        • Create a new MOH for Domain from TTS
        • Update MOH for Domain from TTS
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
        • Delete MOH for Domain
      • User
        • Read MOH for User
        • Count MOH for User
        • Create a new MOH for Domain from TTS
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Delete MOH for User
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Count Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Count Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • 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
    • 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 Domain Contacts
      • Get Specific Domain Contact
      • Create Shared Contact
      • Update Shared Contact
      • Delete Shared Contact
    • 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
      • Read SMS Blocks for Domain
      • Read SMS Blocks for all Domains
      • Update SMS Block for Domain
      • Delete/Deactivate SMS Block for Domain
      • Add SMS Blocks for Domain
    • 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
  • 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
    • 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
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • 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
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Count Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Read a Specific Configuration Definition
      • Create a Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • 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)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete All Timeframes for User
      • Delete Specific Timeframe for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • 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 Code Packages on Hostname
  • iNSight
    • Query Data from iNSight
  • Conference
    • Conferences
      • Get Conferences in Domain
      • Get Conference in Domain
      • Count Conferences in Domain
      • Get Conference CDR from Domain
      • Create Conference for Domain
      • Update Conference in Domain
      • Delete Conference in Domain
    • Participants
      • Get Participants from Conference
      • Create Participant for Conference
      • Update Participant for Conference
      • Delete Participant from Conference
  • 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
  • Aduit Log
    • Read Audit Log
  • Access Log
    • Read Accesslog
  • 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
    • Enums
      • YesNoString
      • YesNoStringYesDefault
      • YesNoStringNoDefault
      • StringDefaultStar
      • DomainName
      • DomainNamePath
      • UserName
      • UserNamePath
      • SuccessResponse
      • ErrorResponse
      • 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
  1. Schemas

Dashboard

{
    "id": 0,
    "name": "string",
    "domain": "string",
    "favorite": true,
    "owner_id": "string",
    "owner_type": 0
}
Built with