1. Default Folder
NetSapiens API v2
  • Version
    • Get API version
    • Check API health
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get access token
      • Get JWT from OAuth grant
      • Link SSO identity to user
    • API Key (Machine 2 Machine)
      • List API keys
      • Get your API key
      • Create API key
      • Update API key
      • Revoke API key
      • Get API key
    • JWT (JSON Web Token)
      • Create JWT
      • Revoke JWTs
      • Revoke current JWT
      • Read current JWT
      • Generate short-lived application JWT
    • NetsapiensJs Auth
      • MFA
        • Generate MFA authenticator secret
        • Verify MFA passcode
        • Enroll in MFA with username and password
        • Enroll in MFA with access token
        • Remove MFA enrollment
      • Refresh session tokens
      • Start OIDC login
    • Masquerade
  • Resellers
    • List territories
    • Create territory
    • Count territories
    • Update territory
    • Delete territory
    • Read territory
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Get phone numbers for domain
    • Create phone number
    • Count phone numbers for domain
    • Get phone numbers for all domains
    • Count phone numbers for all domains
    • Delete phone number
    • Update phone number
    • Get phone number
    • List phone numbers for domain
    • Change phone number routing
  • Phones/Macs
    • Supported Models and Servers
      • Create core server
      • Read NDP connection config
      • Update core server
      • Delete core server
      • Create device model
      • Read device model
      • Update device model
      • Delete device model
      • List device model overrides
      • Create device model override
      • Read raw device model overrides
      • Replace raw device model overrides
      • Delete raw device model overrides
      • Read device model override
      • Update device model override
      • Delete device model override
      • List device models
      • List core servers
      • Read core server
    • Phone Configurations
    • Provisioning Defaults
      • List domains with provisioning defaults
      • List sites with provisioning defaults
      • List brand defaults
      • Create brand default
      • List brands with defaults
      • List defaults for brand
      • Create default for brand
      • List defaults for brand and server
      • Read brand default
      • Update brand default
      • Delete brand default
      • List domain provisioning defaults
      • Create domain provisioning option
      • List domain provisioning defaults for server
      • Read raw domain provisioning defaults
      • Replace raw domain provisioning defaults
      • Delete raw domain provisioning defaults
      • Read domain provisioning option
      • Update domain provisioning option
      • Delete domain provisioning option
      • List site provisioning defaults
      • Create site provisioning option
      • List site provisioning defaults for server
      • Read raw site provisioning defaults
      • Replace raw site provisioning defaults
      • Delete raw site provisioning defaults
      • Read site provisioning option
      • Update site provisioning option
      • Delete site provisioning option
    • List phones
    • Count phones
    • List phones in domain
    • Read phone
    • Read phone in domain
    • Add phone
    • Add phone in domain
    • Update phone
    • Update phone in domain
    • Delete phone
    • Delete phone in domain
    • Read phone configuration file in domain
    • Read phone configuration file
    • Count phones in domain
    • List phone summaries
    • List phone summaries 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
    • List device profiles
    • Count Device Profiles
    • Read a device profile
    • 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
    • Create a device profile
    • Update a device profile
    • Delete a device profile
  • Event Subscriptions
    • List event subscriptions
    • List domain event subscriptions
    • Read event subscription
    • Create event subscription
    • Update event subscription
    • Update domain event subscription
    • Delete event subscription
    • Delete domain event subscription
    • Create domain event subscription
    • List domain event subscription summaries
  • Domains
    • Domain Templating
      • Create a Domain Template
      • Create a Domain From Template
    • Create a Domain
    • Get Domains
    • Count Domains
    • Get Specific Domain
    • Update a Domain
    • Delete a Domain
    • Get Specific Domain With Billing Summary
    • Get My Domain Info
    • Check if Domain Exists
    • Get a domain's SIP servers
  • 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
    • Search for Users in Domain
  • Devices
    • List user devices
    • Count domain devices
    • Count territory devices
    • Count user devices
    • Count domain devices by name
    • Create user device
    • Update user device
    • Delete user device
    • Read user device
    • List domain devices
    • List devices
    • Read device profile image
    • Read domain device
    • List territory devices
    • Reboot user device
    • Reboot domain device
    • Reboot domain devices in bulk
    • List domain device summaries
    • List user device summaries
  • Sites
    • List site summaries
    • List sites
    • Count sites
    • Create site
    • Update site
    • Read site
    • Delete site
  • Call Center
    • Callqueues
      • List call queues
      • Create call queue
      • Update call queue
      • Delete call queue
      • Read call queue
      • List call queue summaries
      • Count call queues in domain
      • Count call queues across domains
    • Agents
      • List agents in call queue
      • Count agents in call queue
      • List agents in domain
      • Read agent in call queue
      • Add agent to call queue
      • Update agent in call queue
      • Remove agent from call queue
      • Count agents in domain
      • List agent summaries in domain
      • List agent summaries in call queue
    • Agent Actions
      • Read agent status
      • Set agent offline
      • Log agent in
      • Log agent out
      • Set agent to single call mode
      • Set agent offline reason
    • QueuedCalls
      • List queued calls
      • Add callback to call queue
      • Prioritize 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
      • List Domain Dispositions
  • Answer Rules
    • List answer rules
    • Count answer rules
    • Read answer rule
    • Create answer rule
    • Delete answer rule
    • Update answer rule
    • Reorder answer rules
    • List answer rule summaries
  • Dialrule
    • List dial rules in dial plan
    • Create dial rule
    • Count dial rules in dial plan
    • Read dial rule
    • Update dial rule
    • Delete dial rule
    • List dial plans
    • Create dial plan with domain in body
    • Create dial plan in domain
    • Update dial plan
    • Delete dial plan
    • Count dial plans
    • List dial rule summaries in dial plan
    • Read admin-only dial plan
    • Create admin-only dial plan
    • Update admin-only dial plan
    • Delete admin-only dial plan
    • List dial rules in admin-only dial plan
    • Create dial rule in admin-only dial plan
    • Count dial rules in admin-only dial plan
    • Read dial rule in admin-only dial plan
    • Update dial rule in admin-only dial plan
    • Delete dial rule in admin-only dial plan
    • List dial plans in domain
    • Count dial plans in domain
    • Read dial plan
    • List dial plan summaries
    • List dial rule summaries in admin-only dial plan
  • Call Blocking
    • Read domain blocked numbers
    • Add domain blocked numbers
    • Remove domain blocked numbers
    • Read user blocked numbers
    • Add user blocked numbers
    • Remove user blocked numbers
  • Auto Attendant
    • Create auto attendant
    • List auto attendants in domain
    • Read auto attendant
    • Update auto attendant
    • Delete auto attendant
    • Count auto attendants in domain
    • List auto attendants with list access
  • Media
    • Voicemail
      • List voicemail in folder
      • Count voicemail in folder
      • Read voicemail message
      • Save voicemail message
      • Forward voicemail message
      • Delete voicemail message
      • Play voicemail
    • Greetings
      • List user greetings
      • Count user greetings
      • Read user greeting
      • Delete user greeting
      • Create user greeting
      • Update user greeting
      • Play greeting
    • Music on Hold
      • Domain
        • List domain MoH files
        • Count domain MoH files
        • Reorder domain MoH files
        • Delete domain MoH file
        • Read domain MoH file
        • Create domain MoH file
        • Update domain MoH file
        • Play domain MoH file
      • User
        • List user MoH files
        • Count user MoH files
        • Reorder user MoH files
        • Delete user MoH file
        • Read user MoH file
        • Create user MoH file
        • Update user MoH file
        • Play user MoH file
    • Hold Messages
      • Domain
        • List domain hold messages
        • Count domain hold messages
        • Create domain hold message
        • Update domain hold message
        • Reorder domain hold messages
        • Delete domain hold message
        • Read domain hold message
        • Play domain hold message
      • User
        • List user hold messages
        • Count user hold messages
        • Create user hold message
        • Update user hold message
        • Reorder user hold messages
        • Delete user hold message
        • Read user hold message
        • Play user hold message
    • Text to Speech
      • List text-to-speech voices
      • Synthesize speech
      • Synthesize speech with query string
  • CDR (Call History)
    • CDR (Call History)
    • List CDRs
    • List domain CDRs
    • List user CDRs
    • Count CDRs
    • Count domain CDRs
    • Count user CDRs
    • Read CDR
    • Update CDR
    • Read domain CDR
    • Update domain CDR
    • Read user CDR
    • Update user CDR
    • Read domain CDR statistics
    • Read CDR statistics
    • Rank domains by call volume
    • Read domain call quality
    • Read call quality
  • CDR Schedule
    • Count domain CDR schedules
    • List domain CDR schedules
    • Create domain CDR schedule
    • Update domain CDR schedule
    • Delete domain CDR schedule
    • Read domain CDR schedule
    • Count reseller CDR schedules
    • Count domain CDR schedules by name
    • List CDR schedules
    • Create CDR schedule
    • Read CDR schedule
    • Update CDR schedule
    • Delete CDR schedule
    • Read reseller CDR schedule
    • Update reseller CDR schedule
    • Delete reseller CDR schedule
    • List reseller CDR schedules
    • Create reseller CDR schedule
    • Count CDR schedules
    • List CDR schedule names
    • List domain CDR schedule names
    • List reseller CDR schedule names
  • Call Traces & Cradle to Grave
    • Get call trace by CDR ID
    • Get cradle to grave by CDR ID
    • Share call trace by CDR ID
    • Share call trace
    • Share call trace without domain
    • Get call trace by CDR ID in domain
    • Get call trace by CDR ID without domain
    • Export call trace
    • Export call trace in domain
    • Export call trace by link
    • Export call trace in domain by link
    • Download shared call trace as text
    • Revoke call trace share
    • Revoke call trace share in domain
    • Get call trace
    • Inject event into call trace
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Calls (live/active calls)
    • List active calls in domain
    • Read active call in domain
    • Count active calls in domain
    • List user active calls
    • Read user active call
    • Create call
    • Disconnect call
    • Transfer call peer
    • Transfer call
    • Answer call
    • Hold call
    • Resume held call
    • Reject call
    • Report concurrent calls
    • List active call history for domain
    • List active call history
    • Run call action
  • Contacts
    • Shared Contacts
      • Count shared contacts
      • Delete shared contacts by name
      • List shared contacts
      • Create shared contact
      • Read shared contact
      • Update shared contact
      • Delete shared contact
      • List shared contacts (reduced)
    • List user contact groups
    • Delete user contacts by name
    • List user contacts
    • Create user contact
    • Read user contact
    • Update user contact
    • Delete user contact
    • Count user contacts
    • List user contacts (reduced)
  • Addresses
    • Get Addresses for Domain
    • Create Address for Domain
    • Validate Address
    • Update Address for Domain
    • Delete Address For Domain
    • Update Address for User
    • Get Address Using Address ID
    • Update Address Endpoint
    • Delete Address Endpoint
    • Create Address for User
    • Get Addresses for User
    • Delete Address For User
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Count Domain Addresses
    • List Domain Addresses
    • List User Addresses
  • Voicemail Reminders
    • Read voicemail reminders
    • Count voicemail reminders
    • Delete voicemail reminders
    • Create voicemail reminders
    • Update voicemail reminders
  • Dial Permisions
    • List dial policies
    • Count dial policies
    • Read dial policy
    • List domain dial policies
    • Read domain dial policy
    • List shared dial policy rules
    • List domain dial policy rules
    • Read shared dial policy rule
    • Read domain dial policy rule
    • Create dial policy
    • Update shared dial policy
    • Update domain dial policy
    • Create shared dial policy rule
    • Create domain dial policy rule
    • Update shared dial policy rule
    • Update domain dial policy rule
    • Delete shared dial policy rule
    • Delete domain dial policy rule
    • Delete shared dial policy
    • Delete domain dial policy
    • List domain dial policies, reduced
    • List domain dial policy rules, reduced
    • Create domain dial policy
  • 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
    • Add Participant to Messagesession
    • Remove Participant from Messagesession
    • Create a message session
    • 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 (Session Name)
  • SMS Numbers
    • Get SMS Numbers for Domain
    • Read SMS number
    • Count domain SMS numbers
    • List domain SMS numbers
    • Create SMS number
    • List SMS numbers
    • Update SMS number
    • Delete SMS number
    • List user SMS numbers
    • Count user SMS numbers
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
    • Play Recording
  • Email
    • Send Email using Template
    • Validate SMTP creds and Send Test Email
    • Send Call Center Email Report
  • Connections
    • Read domain connection
    • List domain connections
    • Delete domain connection
    • Update domain connection
    • Create domain connection
    • Create connection
    • List connections
    • Read connection
    • Update connection
    • Delete connection
    • Count connections
    • List domain connections, reduced
  • Routes
    • List routes
    • Count routes
    • List route connections
    • Count route connections
    • Create route
    • Create route connection
    • Update route
    • Update route connection
    • Delete route
    • Delete route connection
    • List route connections
  • Route Profiles
    • List domain route profiles
    • Create domain route profile
    • Read domain route profile
    • Update domain route profile
    • Delete domain route profile
    • List route profiles
    • Read route profile
    • Update route profile
    • Delete route profile
  • Meetings
    • Event Logs
      • Log meeting event
      • Read meeting events
    • Iotum
      • List video service resellers
      • Read video host for user
      • List video hosts in domain
      • List video conferences for user
      • List video contacts for user
      • Read domain video account
      • List domain video subscriptions
      • List available video products
      • Create video host for user
      • Add video contacts for user
      • Create video subscription
      • Update domain video account
      • Update domain video plans
      • Update video host for user
      • Cancel video subscription
      • Delete video host for user
      • Create domain video account
      • Start ad hoc video conference
      • Delete domain video account
      • Read video subscription
      • Read video host for user
      • List video contacts for user
    • Read meeting by registration ID
    • Reserve meeting ID (alias)
    • Read meeting (instance path)
    • Read meeting as attendee
    • Update meeting attendee
    • Create video join token
    • Read recording playback token
    • Create meeting with ID
    • Read meeting
    • Create meeting
    • List meetings for user
    • Count meetings in domain
    • Count meeting
    • Register for meeting
    • Update meeting
    • Delete meeting
    • Reserve meeting ID
    • List meetings for user (identity only)
  • Backup & Restore
    • List domain restore points
    • Restore domain from backup by path
    • Back up domain
    • Start full system backup
    • List restore points
    • Restore domain from backup
  • Configs
    • Configurations
      • NS Configs
      • NMS Configs
        • List NMS configuration entries
        • Create NMS configuration entry
        • Count NMS configuration entries
        • List NMS configuration key names
        • List NMS configuration servers
        • Read NMS configuration entry
        • Update NMS configuration entry
        • Delete NMS configuration entry
      • LiCf Configs
        • List recording configuration entries
        • Create recording configuration entry
        • List recording configuration servers
        • Read recording configuration entry
        • Update recording configuration entry
        • Delete recording configuration entry
        • List media converter configuration entries
        • Create media converter configuration entry
        • List media converter configuration servers
        • Read media converter configuration entry
        • Update media converter configuration entry
        • Delete media converter configuration entry
        • List archive policies
        • Create archive policy
        • Read archive policy
        • Update archive policy
        • Delete archive policy
      • NDP Configs
        • List NDP configuration entries
        • Create NDP configuration entry
        • List NDP configuration servers
        • Read NDP configuration entry
        • Update NDP configuration entry
        • Delete NDP configuration entry
      • Read configuration
      • List configurations
      • Count configurations
      • Create configuration
      • Update configuration
      • Delete configuration
    • Configuration Definitions
      • List configuration definitions
      • Create configuration definition
      • Read configuration definition
      • Update configuration definition
      • Delete configuration definition
  • Images
    • Read image
    • Create Image from Upload (JSON + Base64 File)
    • Delete image
    • Update Image from Upload (Multipart/Mixed Post)
    • Create image
    • Update image
  • Templates
    • Read template
    • Create Template from Upload (JSON + Base64 File)
    • Delete template
    • Create template
    • Update Template from Upload (JSON + Base64 File)
    • Update template
  • Timeframes
    • Domain (Shared)
      • Always
      • Specific Dates
      • Days of Week
      • Holiday
      • Custom
        • Add entries to domain time frame
        • Delete domain time frame
        • Create domain time frame
        • Update domain time frame
      • Count domain time frames
      • List domain time frames
      • Read domain time frame
      • List domain time frame names
    • User
      • Always
      • Specific Dates
      • Days of Week
      • Holiday
      • Custom
        • Add entries to user time frame
        • Delete user time frame
        • Create user time frame
        • Update user time frame
      • List user time frames
      • Read user time frame
      • List user time frame names
    • Holiday Information
      • List holiday countries
      • List holiday regions
      • List holidays by country
      • List holidays by country and region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • List SSL certificates
    • Read SSL certificate
    • Create SSL certificate
    • Update SSL certificate
    • Delete SSL certificate
    • Count SSL certificates
    • Validate certificate hostnames
  • Code Management
    • List cluster servers
    • List installed packages across cluster
    • List installed packages on server
    • Refresh package lists on receiving server
    • List repositories on server
    • Add repository version
    • Install packages on server
    • Upgrade all packages on server
    • Remove unused packages on server
    • Remove repository version
    • Refresh package lists on server
  • iNSight
    • Query Healthcheck Data from iNSight
    • Query Data from iNSight for alerts
    • Query Healthcheck Data from iNSight
  • Conference
    • Conferences
      • List conferences in domain
      • Read conference
      • Count conferences in domain
      • List conference session summaries
      • Create conference
      • Update conference
      • Delete conference
      • List domain conferences, reduced
    • Participants
      • List conference participants
      • Add conference participant
      • Update conference participant
      • Remove conference participant
      • Read conference participant
      • List conference participants, reduced
  • Charts
    • Count Charts
    • List Charts
  • Dashboards
    • Count Dashboards for a User
    • List User Dashboards
  • Quotas
    • Read domain recording quota
    • List reseller recording quotas
    • Count domain recording quotas
    • Count reseller recording quotas
    • Count recording quotas
    • Create domain recording quota
    • Update domain recording quota
    • Delete domain recording quota
    • List recording quotas
    • Create recording quota
    • Read recording quota
    • Update recording quota
    • Delete recording quota
    • Create reseller recording quota
    • Read reseller recording quota
    • Update reseller recording quota
    • Delete reseller recording quota
  • Departments
    • List departments (list suffix)
    • List departments
    • Count departments
    • Read department
  • Presence
    • List Presence in a Domain
    • List Presence in a Department
  • Audit Log
    • Read Audit Log
  • Access Log
    • Read Accesslog
  • Avatars
    • Generic
      • List generic avatars
      • Add generic avatar using PUT
      • Add generic avatar
      • Delete generic avatar
    • Replace user avatar
    • Read user avatar by filename
    • Delete user avatar by filename
    • Read user avatar
    • Count user avatars
    • Replace user contact avatar
    • Replace shared contact avatar
    • Upload user avatar
    • Upload user contact avatar
    • Upload shared contact avatar
    • Delete user avatar
    • Read user contact avatar
    • Delete user contact avatar
    • Read shared contact avatar
    • Delete shared contact avatar
    • Read user contact avatar by filename
    • Delete user contact avatar by filename
    • Read shared contact avatar by filename
    • Delete shared contact avatar by filename
    • Read avatar image
    • Read avatar image by size
  • Translations
    • Get Available Locales
    • Get Available Namespaces
    • Get All Translations for Locale
    • Get Translations for Locale and Namespace
    • Get All Translations (Raw Database Data)
    • Create Translation(s)
    • Update Translation(s)
    • Delete Translation(s)
    • Sync Filesystem
  • License
    • List license entries
    • List license entries for a specific host
  • Reject Log
    • List rejected SIP requests
    • List rejected SIP requests for a specific host
  • Push Notifications
    • List platform push devices
    • List push registrations
    • List domain push registrations
    • List user push registrations
    • Register push device for user
    • Update push registration for user
    • Unregister push device for user
    • Register push device
    • Update push registration
    • Unregister push device
    • Register push device in domain
    • Update push registration in domain
    • Unregister push device in domain
    • List domain push devices
    • List user push devices
  • App Info
    • List element domain records
  • Brands
    • Global
      • List all brands (Super User)
    • Reseller
      • 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 active brand for hostname (resolved)
      • Get a specific brand (full data)
      • Create a new brand
      • Update a brand
      • Delete a brand
      • Copy a brand
    • Domain
      • List brands for a domain (minimal fields)
      • Get all brands for a domain (full data)
      • Create a new brand (domain-scoped)
      • List brands for domain + hostname (minimal fields)
      • Get all brands for domain + hostname (full data)
      • Get active brand for domain + hostname (resolved)
      • Get a specific brand (domain-scoped)
      • Update a brand (domain-scoped)
      • Delete a brand (domain-scoped)
      • Copy a brand (domain-scoped)
  • Brand Assets
    • Reseller
      • List assets for a brand
      • Upload a new brand asset
      • Get a specific asset (metadata)
      • Replace a brand asset image
      • Delete a brand asset
      • Download brand asset (binary)
    • Domain
      • List assets (domain-scoped)
      • Upload asset (domain-scoped)
      • Get asset metadata (domain-scoped)
      • Replace asset image (domain-scoped)
      • Delete asset (domain-scoped)
      • Download asset binary (domain-scoped)
  • vCon
    • Read the vCon for a parent cdr_id (domain-scoped)
    • Read the vCon for a parent cdr_id, scoped to a specific user
  • Phones
    • Macs
      • Supported Models and Servers
  • Horizon SDK
    • UIExtensions
      • Runtime projection — what should this browser execute
      • List manageable extensions
      • Register an extension
      • Get one extension
      • Update an extension
      • Delete an extension
      • List access rules
      • Create an access rule
      • Update an access rule
      • Delete an access rule
      • Verification history (read-only)
      • Read platform-global SDK settings
      • Update platform-global SDK settings
      • Re-judge stored versions against the current ruleset
      • Deploy a bundle — fetch, verify, promote
  • Inboxes
    • Get Inboxes in Domain
    • Get Single Inbox
    • Get Inboxes a User is a Member of
    • Create Inbox
    • Update Inbox
    • Delete Inbox
    • Get Members in an Inbox
    • Add Member to Inbox
    • Update Member in Inbox
    • Remove Member from Inbox
  • Defaults
    • Update domain default
    • Delete domain default
    • Update reseller default
    • Delete reseller default
    • List defaults
    • Create default
    • Update default
    • Delete default
    • List defaultable objects
    • List defaultable fields
    • List domain defaults
    • Create domain default
    • List reseller defaults
    • Create reseller default
    • List domain default summaries
  • Speech Words
    • List system speech word names
    • List system speech words
    • Read system speech word
    • Create or update system speech word
    • Download system speech word audio
    • Render system speech word with text to speech
    • Upload system speech word audio
    • List domain speech words
    • Read domain speech word
    • Create or update domain speech word
    • Delete domain speech word override
    • Download domain speech word audio
    • Render domain speech word with text to speech
    • Upload domain speech word audio
    • Play system speech word from signed link
    • Render system speech words in bulk
    • Play domain speech word from signed link
    • Render domain speech words in bulk
    • List domain speech word names
  • User Settings
    • List user settings
    • Create or update user setting
    • Read user setting
    • Update user setting
    • Create or update user setting by name
    • Delete user setting
    • List user setting names
  • Network Tests
    • List network test reports
    • Create a network test report
    • Get a single network test report
    • Delete a network test report
    • List a user's network test reports
    • Create a network test report for a user
    • Get a single network test report under a user
    • Delete a network test report under a user
    • List network test reports system-wide
    • Get a single network test report (system-wide)
    • Delete a network test report (system-wide)
  • SMS Carriers
    • List SMS carriers
    • Create a custom SMS carrier
    • Read an SMS carrier
    • Update an SMS carrier
    • Delete a custom SMS carrier
  • ipaware
    • allowed-ips
      • List allowed IPs
      • Add allowed IPs
      • Remove allowed IPs
      • Remove allowed IPs with POST
    • config
      • Read configuration
      • Update configuration
      • Read configuration key
      • Update configuration key
      • Reset configuration key
    • service
      • Restart service
      • Check service health
    • diagnostics
      • Read service status
      • Read core scanner status
    • firewall
      • Read firewall blocks
      • Read firewall counters
      • Block IP addresses
      • Unblock IP addresses
  • Service Codes
    • Read a Service Code
    • Update a Service Code
    • Delete a Service Code
    • Read a Service Code for a Domain
    • Update a Service Code for a Domain
    • Delete a Service Code for a Domain
    • List Service Codes
    • Create a Service Code
    • Count Service Codes
    • List Service Codes for a Domain
    • Create a Service Code for a Domain
    • Count Service Codes for a Domain
    • List Domain Service Codes
  • Recording Servers
    • Count recording servers
    • Count recording entries
    • Count recording entries on server
    • Update recording entry on server
    • Delete recording entry on server
    • List recording servers
    • Create recording server
    • Read recording server
    • Update recording server
    • Delete recording server
    • List recording entries on server
    • Create recording entry on server
    • List recording entries
    • Create recording entry
    • Update recording entry
    • Delete recording entry
    • List recording servers by core server
    • List recording servers on core server
    • Update recording servers on core server
    • Copy recording entries from server
    • Read entry copy job
    • Cancel entry copy job
  • OAuth Clients
    • List OAuth Clients
    • Create an OAuth Client
    • Count OAuth Clients
    • Read an OAuth Client
    • Update an OAuth Client
    • Delete an OAuth Client
  • OAuth Tokens
    • List Issued Tokens
    • Count Issued Tokens
    • Read an Issued Token
    • Revoke an Issued Token
  • Domain Templates
    • Read domain templates
    • Count domain templates
    • Read a template's variables
    • Count a template's variables
    • Check that a template carries one variable
  • Call Parks
    • List call parks across domains
    • Create call park, domain in body
    • Count call parks across domains
    • List domain call parks
    • Create domain call park
    • Count domain call parks
    • Read call park
    • Update call park
    • Delete call park
    • List domain call park summaries
  • Call Queues
  • NMS Status
    • Read NMS Status Series
    • List NMS Status Metrics
    • List NMS Status Servers
  • Custom Scopes
    • List Custom Scopes
    • Create Custom Scope
    • Count Custom Scopes
    • Read Custom Scope
    • Update Custom Scope
    • Delete Custom Scope
  • Domain Settings
    • System
      • List system settings
      • Create or update system setting
      • Read system setting
      • Update system setting
      • Delete system setting
    • Reseller
      • List reseller settings
      • Create or update reseller setting
      • Read reseller setting
      • Update reseller setting
      • Delete reseller setting
    • Read settings catalog
    • List domain settings
    • Create or update domain setting
    • Read domain setting
    • Update domain setting
    • Delete domain setting
  • Recording Storage
    • List remote storage services (platform)
    • List a domain's remote storage services
    • Create a remote storage service for a domain
    • Read a remote storage service
    • Update a remote storage service
    • Delete a remote storage service
  • Processes
    • List processes across the cluster
    • List processes on one server
    • Count processes across the cluster
    • List processes, projected to selected fields
  • Services
    • List controllable services
    • List services on server
    • Read service status
    • Reload unit files on server
    • Start, stop, or restart service
  • Schemas
    • Schemas
      • Authentication
      • Address
    • Enums
    • securitySchemes
    • Default Folder
      • Inbox
      • InboxMember
      • AuthRequirement
      • Domain Read - Additional Parameters
      • NdpServerListItem
      • User Read Additions
      • MasqueradeStartResponse
      • MasqueradeErrorResponse
      • MohUpdateDescription
      • CallTraceSvg
      • CallTraceCradleEvent
      • CallTraceCradle
      • CallTraceCsvBlob
      • CallTraceEnvelope
      • CallTraceDevice
      • CallTraceMessage
      • CallTracePushSummary
      • CallTraceDetails
      • CallTraceGetResponse
      • CallTraceByCdrResponse
      • CallTraceShare
      • CallTraceShareEnvelope
      • CallTraceShareRequest
      • CallTraceExportRequest
      • CallTraceEventInject
      • CallTraceEventCreated
      • ContactCreate
      • ContactUpdate
      • ContactAvatarFile
      • AvatarUpload
      • AvatarFile
      • AvatarListItem
      • AvatarList
      • GenericAvatar
      • GenericAvatarList
      • AvatarCount
      • CallQueueListItem
      • CallQueueCreate
      • CallQueueUpdate
      • AgentCreate
      • AgentUpdate
      • AgentStatus
      • QueuedCall
      • QueuedCallPrioritize
      • QueuedCallCallback
      • GreetingFile
      • GreetingFileList
      • HoldMessageFile
      • HoldMessageFileList
      • GreetingCount
      • HoldMessageCount
      • VoicemailCount
      • GreetingUploadCreate
      • GreetingUploadUpdate
      • GreetingCreateBase64
      • GreetingCreateTextToSpeech
      • GreetingCreateJson
      • GreetingUpdateBase64
      • GreetingUpdateDescription
      • GreetingUpdateJson
      • HoldMessageUploadCreate
      • HoldMessageUploadUpdate
      • HoldMessageCreateBase64
      • HoldMessageCreateTextToSpeech
      • HoldMessageCreateJson
      • HoldMessageUpdateBase64
      • HoldMessageUpdateDescription
      • HoldMessageUpdateJson
      • HoldMessageReorderRequest
      • VoicemailMessage
      • VoicemailMessageList
      • VoicemailForwardRequest
      • TextToSpeechVoice
      • TextToSpeechVoiceList
      • TextToSpeechRequest
      • DefaultRecord
      • DefaultKey
      • DefaultObject
      • DefaultObjectField
      • PackageVersionOption
      • ServiceCatalogEntry
      • ServiceState
      • ServiceStatus
      • ServiceList
      • ServiceActionResult
      • ServiceActionDeferred
      • ServiceDaemonReloadResult
      • ServiceNotInstalledError
      • ServiceTimeoutError
      • TicketRequest
      • NmcConfigWrite
      • NmcConfigUpdate
      • ConfigurationRecord
      • ConfigurationWrite
      • ConfigurationUpdate
      • ConfigurationKey
      • ConfigDefinitionRecord
      • ConfigDefinitionWrite
      • ConfigDefinitionUpdate
      • NsConfigEntry
      • NsConfigWrite
      • NsConfigKey
      • AnswerruleToggle
      • AnswerruleCreate
      • AnswerruleUpdate
      • AnswerruleReorder
      • PhoneDeleteRequest
      • ParkUpdate
      • SpeechWordRenderResult
      • SpeechWordUploadMultipart
      • IpawareBatchResult
      • IpawareProxyOrServiceError
      • IpawareAllowedIpAnswer
      • IpawareFirewallOpAnswer
      • IpawareConfigUpdate
      • IpawareConfigValue
      • PushCreate
      • PushUpdate
      • PushDelete
      • PushWriteResult
      • NumberFilter
      • NumberFilterWrite
      • NumberFilterRemove
      • RestorePoint
      • RestorePointsByServer
      • RestoreResult
      • FullBackupStartResponse
      • DomainRestoreRequest
      • SslCertificateCreate
      • SslCertificateUpdate
      • SmsNumberCreate
      • SmsNumberUpdate
      • ConferenceRecord
      • ConferenceCreate
      • ConferenceUpdate
      • ConferenceParticipantRecord
      • ConferenceParticipantCreate
      • ConferenceParticipantUpdate
      • ConferenceSessionSummary
      • CallDialRequest
      • CallRecordRequest
      • CallCreateRequest
      • CallActionRequest
      • ActiveCallHistory
      • CallActivityReportRequest
      • ImageDetails
      • ImageUpload
      • ImageBase64
      • ImageLocation
      • VmailnagWrite
      • TemplateDetails
      • TemplateUpload
      • TemplateBase64
      • TemplateLocation
      • AutoAttendantScript
      • AutoAttendantIntroInput
      • AutoAttendantOptionInput
      • AutoAttendantTierInput
      • AutoAttendantCreate
      • AutoAttendantUpdate
      • MeetingEvent
      • MeetingWrite
      • MeetingDelete
      • MeetingEventLog
      • MeetingEventWrite
      • MeetingIdReservation
      • MeetingRegistration
      • MeetingAttendeeWrite
      • MeetingVideoToken
      • MeetingAttendeeView
      • VideoAccountCreate
      • VideoAccountUpdate
      • VideoSubscriptionCreate
      • VideoPlansUpdate
      • VideoAccount
      • VideoAccountCreateResult
      • VideoSubscription
      • VideoProduct
      • VideoAccountHost
      • VideoResellerList
      • IotumVideoHost
      • IotumVideoContact
      • IotumVideoConference
      • IotumVideoResult
      • IotumHostUpdate
      • IotumConferenceCreate
      • BackupRequest
      • AuthenticationRequired
      • BadRequest
      • PhoneListItem
      • RecordNotFound
      • RouteProfile
      • Vcon
      • MfaDeleteRequest
      • MfaEnrollWithTokenRequest
      • MfaEnrollRequest
      • MfaVerifyResponse
      • MfaVerifyRequest
      • GenAuthenticatorRequest
      • BrandAsset
      • Brand
      • InsightAlertResponse
      • ApplicationTokenResponse
      • ApplicationTokenRequest
      • AppinfoR
      • PushR
      • RejectlogR
      • LicenseR
      • BulkTranslationResponse
      • Error
      • TranslationRawRecord
      • HealthResponse
      • TranslationCreateResponse
      • TranslationNamespacesResponse
      • TranslationLocalesResponse
      • CdrUpdatable
      • MasqueradePopNoTargetResponse
      • MasqueradeV2EndResponse
      • MasqueradeV2Response
      • RefreshCookieResponse
      • MeResponse
      • NetsapiensJsResponse
      • PackageRepository
      • PackageRepositoryList
      • CodeApplicationServerDetails
      • DialpolicyUpdate
      • CodeApplicationServer
      • PermissionCreate
      • CodeApplication
      • AuthenticationRequired1
      • PermissionUpdate
      • BadRequest1
      • RecordNotFound1
      • RouteProfileCallRouting
      • EmailTestResponse
      • EmailValidate
      • RouteProfileCreate
      • Avatar
      • RouteProfileUpdate
      • OIDCProvider
      • SmsBlock
      • ConnectionCreate
      • SSOEnroll
      • AbandondedCallStat
      • DomainConnectionCreate
      • Phoneconfiguration
      • ConnectionUpdate
      • PhoneConfigBtn
      • QueueStat
      • CdrCount
      • Auditlog
      • InsightValue
      • CdrUpdate
      • Holiday
      • CdrScheduleListItem
      • DeviceModelButtonType
      • DeviceModel
      • ResellerUpdate
      • DeviceImage
      • DeviceProfile
      • SiteCreateRequest
      • DeviceProfileButton
      • SiteUpdateRequest
      • Dialpolicy
      • Permission
      • SubscriptionCreate
      • DispositionReason
      • PublicUserInfo
      • SubscriptionUpdate
      • RouteConnection
      • TimeframeSpecificDateNew
      • Route
      • Presence
      • TimeframeDOWNew
      • Dashboard
      • Chart
      • TimeframeHolidayNew
      • AnswerruleFeatureSimRing
      • TimeframeCreateAlways
      • ConferenceCDR
      • Conference
      • TimeframeCreateDaysOfWeek
      • ConferenceParticipant
      • Dialplan
      • TimeframeCreateSpecificDates
      • NumberEnabledMap
      • TimeframeCreateHoliday
      • Certficate
      • Start
      • TimeframeCreateCustom
      • Limit
      • Transcription
      • TimeframeCreateRequest
      • CallBlocking
      • TimeframeAddEntriesRequest
      • AnswerruleFeatureWithRemove
      • IotumContact
      • TimeframeConvertType
      • IotumHost
      • RecurringTimeframeHolidayObservance
      • TimeframeReplaceEntries
      • RecurringTimeframeType
      • TimeframeUpdateEntries
      • TimeframeDOW
      • TimeframeHoliday
      • TimeframeUpdateRequest
      • TimeframeSpecificDate
      • TimeframeDeleteRequest
      • RecurringTimeframe
      • RecordingOld
      • TimeframeReadResponse
      • DatetimeEnd
      • DatetimeStart
      • MohFile
      • StringInteger
      • ConfigDefinition
      • MohFileList
      • AuthRequestMFA
      • MohCount
      • StringDefaultStar
      • MimeTypes
      • MohUploadCreate
      • MessageType
      • RecordingConfiguration
      • MohUploadUpdate
      • MeetingStatus
      • MohCreateBase64
      • Template
      • MohCreateTextToSpeech
      • JwtRequestSuccess
      • OneZeroDefaultZero
      • MohCreateJson
      • OneZeroDefaultOne
      • MohUpdateBase64
      • OneZeroBoolean
      • JwtResponse
      • DeletegateRequest
      • Connection
      • MohUpdateJson
      • ConnectionExtra
      • MohReorderRequest
      • DeleteType
      • Timestamp
      • Configuration
      • Meeting
      • SmsNumber
      • AddressCreateReturn
      • BackupResponse
      • Restore
      • MessageSend
      • AddressEndpoint
      • AddressValidate
      • AutoAttendantFailOptions
      • AutoAttendantTierOption
      • AutoAttendantTier
      • AutoAttendant
      • Timerange
      • TtsVoice
      • AgentPath
      • CallqueuePath
      • CallActions
      • DialruleApplication
      • UserNamePath
      • DeviceLegacy
      • Agentlog
      • EmailCreate
      • YesNoStringNoDefault
      • YesNoStringYesDefault
      • UserName
      • DomainNamePath
      • Synchronous
      • Recording
      • ApiKeyAuth
      • SubscriptionModel
      • Subscription
      • DomainName
      • Scopes
      • TimeZone
      • YesNoString
      • DomainBilling
      • User
      • Domain
      • Message
      • Vmailnag
      • Messagesession
      • NdpServer
      • NdpModel
      • NdpPhone
      • CdrU
      • CdrD
      • MediaRequest
      • Audiofile
      • ApiKey
      • Reseller
      • Address
      • AccessToken
      • Timeframe
      • AnswerruleFeature
      • Answerrule
      • Contact
      • Phonenumber
      • DialRule
      • Count
      • CallRequest
      • AuthRequest
      • Site
      • AnswerruleLegacy
      • Agent
      • CallQueue
      • Device
      • UserLegacy
      • DomainLegacy
      • Accesslog
    • Address
      • UserAddressCreateRequest
      • UserAddressCreateReturn
    • Authentication
      • GenAuthenticatorResponse
    • NMS Status
      • NmsStatusMetric
      • NmsStatusServer
      • NmsStatusMetricSeries
      • NmsStatusSeries
    • Custom Scopes
      • CustomScope
      • CustomScopeModifications
    • CDR (Call History)
      • CdrDBase
      • CdrUBase
      • CdrG
      • CdrGBase
    • NDP Endpoints Server (API-3162)
      • NdpCoreServerUpdate
      • DeviceModelUpdate
      • DeviceModelOverrideUpdate
      • BrandDefaultUpdate
      • ProvisioningOptionUpdate
      • ProvisioningDefaultsRawApplied
      • NdpConfigUpdate
      • NdpErrorResponse
      • NdpSuccessResponse
      • NdpConfig
      • NdpConfigWrite
      • NdpConfigApplied
      • NdpConfigServer
      • NdpCoreServer
      • NdpCoreServerWrite
      • NdpServerConfig
      • DeviceModelRow
      • DeviceModelWrite
      • DeviceProfileRow
      • DeviceModelOverride
      • DeviceProfileButtonRow
      • DeviceModelOverrideWrite
      • DeviceProfileWrite
      • DeviceModelOverridesRaw
      • BrandDefault
      • DeviceModelOverridesRawWrite
      • BrandDefaultWrite
      • BrandDefaultApplied
      • BrandDefaultBrand
      • ProvisioningOption
      • ProvisioningOptionWrite
      • ProvisioningOptionApplied
      • ProvisioningDefaultsRaw
      • ProvisioningDefaultsRawWrite
      • ProvisioningDefaultsDomain
      • NdpPhoneAdditionalFields
    • LicfConfigApplied
    • NetworktestR
    • SmscarrierFields
    • ServiceCode
    • OauthClient
    • DomainTemplate
    • HorizonAccessRule
    • DomainSetting
    • LicfConfig
    • ProcessR
    • DeviceListItem
    • ErrorResponse
    • PhonenumberListItem
    • Department
    • ContactListItem
    • SipServers
    • DefaultR
    • NmsConfig
    • Park
    • SpeechWordR
    • IpawareError
    • UsersettingValue
    • ConferenceListItem
    • ActiveCall
    • Recordingserver
    • NetworktestReport
    • SmscarrierR
    • ServiceCodeCreate
    • OauthClientCreate
    • TemplateVariable
    • SiteWrite
    • HorizonAnalysisDenylist
    • AddressListItem
    • DomainSettingCatalog
    • NmcConfig
    • CountResponse
    • DialruleListItem
    • CdrSchedule
    • SipServer
    • DefaultC
    • NmsConfigListItem
    • ParkWrite
    • SpeechWordU
    • IpawareValidationError
    • UsersettingR
    • RecordingserverWrite
    • AttendantListItem
    • HorizonExtension
    • SmscarrierC
    • ServiceCodeKeyedUpdate
    • OauthClientUpdate
    • DomainTemplateProvisionRequest
    • HorizonAnalysisSettings
    • ServicecodeListItem
    • DomainSettingCatalogEntry
    • LicfConfigWrite
    • QuotaCreate
    • ConnectionListItem
    • CdrScheduleInput
    • CdrScheduleUpdate
    • SipServerSrv
    • DefaultU
    • NmsConfigServer
    • ParkListItem
    • SpeechWordRender
    • IpawareAllowedIpAdd
    • PushListItem
    • UsersettingC
    • RecordingCoreserver
    • SmscarrierPortalR
    • ServiceCodeKeyedDelete
    • OauthClientWithSecret
    • DomainTemplateProvisionResponse
    • HorizonCspCoverage
    • DomainSettingEffective
    • LicfConfigUpdate
    • SuccessResponse
    • TimeframeListItem
    • AgentListItem
    • DefaultListItem
    • NmsConfigVerify
    • SpeechWordUpload
    • SpeechWordBulkRender
    • IpawareAllowedIpRemove
    • UsersettingU
    • Recordingentry
    • SmscarrierBuiltinU
    • DomainServiceCodeCreate
    • OauthToken
    • DispositionListItem
    • DomainSettingValue
    • LicfConfigServer
    • DialpolicyListItem
    • RecordingentryWrite
    • NmsConfigCreate
    • AnswerruleListItem
    • SpeechWordBulkResult
    • IpawareAllowedIpMutationResult
    • SmscarrierCustomU
    • DomainServiceCodeKeyedUpdate
    • HorizonExtensionRuntime
    • DomainSettingWrite
    • ArchiveConfig
    • PermissionListItem
    • NmsConfigUpdate
    • IpawareAllowEntry
    • ParticipantListItem
    • RecordingentrySyncRequest
    • MeetingListItem
    • HorizonExtensionSettings
    • ArchiveConfigWrite
    • NmsConfigCount
    • SpeechwordListItem
    • IpawareAllowedIpsList
    • UsersettingListItem
    • RecordingentrySyncResult
    • HorizonExtensionVersion
    • ArchiveConfigUpdate
    • SubscriptionListItem
    • NmsSuccessResponse
    • IpawarePendingChange
    • RecordingentrySyncFailure
    • HorizonReanalyzeEntry
    • RecordingStorage
    • NmsErrorResponse
    • IpawareConfigState
    • RecordingentrySyncAccepted
    • HorizonReanalyzeResult
    • RecordingStorageWrite
    • IpawareConfigKeyState
    • RecordingentrySyncJob
    • HorizonRulePolicy
    • RecordingStorageUpdate
    • IpawareConfigUpdateResult
    • HorizonRulePolicyEntry
    • Quota
    • IpawareStatusZ
    • QuotaWrite
    • IpawareBlockEntry
    • LicfSuccessResponse
    • IpawareFirewallState
    • LicfErrorResponse
    • IpawareFirewallBlockRequest
    • IpawareFirewallUnblockRequest
    • IpawareFirewallOpResult
    • RecordNotFound
    • BadRequest
    • AuthenticationRequired
  1. Default Folder

VideoSubscription

One subscription of a domain's video account, as the video service returns it. Only id, product.slug, and product.plan are relied on by the API; the other fields are set by the video service and passed through.

{
    "id": null,
    "product": {
        "slug": "video_pro",
        "plan": null,
        "property1": "string",
        "property2": "string"
    },
    "property1": "string",
    "property2": "string"
}
Built with