1. Phones/Macs
NetSapiens API v2
  • Default module
    • 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
      • List phone numbers
      • Create phone number
      • Count phone numbers
      • List phone numbers in all domains
      • Count phone numbers in all domains
      • Delete phone number
      • Update phone number
      • Read phone number
      • List phone numbers (short)
      • Update phone number by body
    • 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
        GET
      • Count phones
        GET
      • List phones in domain
        GET
      • Read phone
        GET
      • Read phone in domain
        GET
      • Add phone
        POST
      • Add phone in domain
        POST
      • Update phone
        PUT
      • Update phone in domain
        PUT
      • Delete phone
        DELETE
      • Delete phone in domain
        DELETE
      • Read phone configuration file in domain
        GET
      • Read phone configuration file
        GET
      • Count phones in domain
        GET
      • List phone summaries
        GET
      • List phone summaries in domain
        GET
    • SnapBuilder
      • Phone Templates
        • List phone templates
        • Read phone template
        • Count phone templates
        • Create phone template
        • Update phone template
        • Delete phone template
      • List device profiles
      • Count device profiles
      • Read device profile
      • Count phone configurations
      • Read phone configuration
      • Create phone configuration
      • Update phone configuration
      • Delete phone configuration
      • Create device profile
      • Update device profile
      • Delete 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 domain
      • List domains
      • Count domains
      • Read domain
      • Update domain
      • Delete domain
      • Read domain billing summary
      • Check domain exists
      • Read domain SIP servers
    • Users
      • Count users
      • List users
      • Create user
      • Delete user
      • Update user
      • Read user
      • Read my user
      • List domain directory
      • List users (older path)
    • 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
        • Read call queue statistics
        • Read call queue statistics for all queues
        • List call queue statistics per queue
        • List agent statistics
        • List agent statistics for a call queue
        • Read agent statistics
        • List dialed number statistics
        • List dialed number statistics for a call queue
        • List agent status times
        • List abandoned calls
        • List abandoned calls for a call queue
      • Call Dispositions
        • List call dispositions
        • Create call disposition (not supported)
        • List call dispositions (short)
      • Emailed Reports
        • Read a user's emailed call center reports
        • Set a user's emailed call center reports
        • Stop all of a user's emailed call center reports
    • 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
      • List CDR schedule exports
      • Read CDR schedule export
      • Download CDR schedule export
      • List CDR schedule exports (reseller)
      • Read CDR schedule export (reseller)
      • Download CDR schedule export (reseller)
      • List CDR schedule exports (system-wide)
      • Read CDR schedule export (system-wide)
      • Download CDR schedule export (system-wide)
    • 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
      • Search raw call trace events
    • Transcriptions & Sentiment
      • Read call transcription
    • 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
      • Read domain address
      • Read address endpoint
      • List domain addresses
      • Create domain address
      • Validate address
      • Update domain address
      • Delete domain address
      • Update user address
      • Read user address
      • Update address endpoint
      • Delete address endpoint
      • Create user address
      • List user addresses
      • Delete user address
      • Create address endpoint
      • List address endpoints
      • Count domain addresses
      • List domain address summaries
      • List user address summaries
    • 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
        • List SMS blocks
        • List SMS blocks in all domains
        • Update SMS block
        • Delete SMS block
        • Create SMS block
        • Read SMS block
        • Create SMS block for user
      • List message sessions in domain
      • Start message session
      • List message sessions
      • List messages in session
      • Leave message session
      • Delete message session
      • Create message session
      • Accept call queue conversation
      • Count message sessions
      • Send message
      • Update message session
    • SMS Numbers
      • 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
      • Read recording of user call
      • List recordings of call in domain
      • Play recording
    • Email
      • Test SMTP settings
      • Check email address verification
      • Send email
      • Send email to user
    • 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
      • Delete image
      • Create image
      • Update image
    • Templates
      • Read template
      • Delete template
      • Create template
      • 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
      • List Firebase service accounts
      • Add Firebase service account
      • Delete Firebase service account (query form)
      • Count Firebase service accounts
      • Get Firebase service account
      • Replace Firebase service account
      • Delete 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
      • List active iNSight alerts
      • Read iNSight metric series
    • 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
      • Read charts
      • Create chart
      • Update chart
      • Delete chart
    • Dashboards
      • Count user dashboards
      • List user dashboards
      • Read dashboards
      • Create dashboard
      • Update dashboard
      • Delete dashboard
    • 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 domain presence
      • List department presence
      • Read domain presence
      • Read department presence
    • Audit Log
      • List audit log entries
    • Access Log
      • Read access log
    • 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
      • List available locales
      • List translation namespaces
      • Get translations for a locale
      • Get translations for a namespace
      • List translation records
      • Create translations
      • Update translations
      • Delete translations
      • Sync translations from locale files
      • Get translation descriptions for a locale
    • License
      • List licenses
      • List licenses for a server
    • Reject Log
      • List rejected SIP requests
      • List rejected SIP requests on server
    • 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 server applications
    • Brands
      • Global
        • List all brands
      • Reseller
        • List reseller brand summaries
        • List reseller brands
        • List reseller brand summaries for hostname
        • List reseller brands for hostname
        • Read active reseller brand for hostname
        • Read reseller brand
        • Create reseller brand
        • Update reseller brand
        • Delete reseller brand
        • Copy reseller brand
      • Domain
        • List domain brand summaries
        • List domain brands
        • Create domain brand
        • List domain brand summaries for hostname
        • List domain brands for hostname
        • Read active domain brand for hostname
        • Read domain brand
        • Update domain brand
        • Delete domain brand
        • Copy domain brand
    • Brand Assets
      • Reseller
        • List reseller brand assets
        • Create reseller brand asset
        • Read reseller brand asset
        • Update reseller brand asset
        • Delete reseller brand asset
        • Download reseller brand asset
      • Domain
        • List domain brand assets
        • Create domain brand asset
        • Read domain brand asset
        • Update domain brand asset
        • Delete domain brand asset
        • Download domain brand asset
    • vCon
      • Read vCon for CDR
      • Read vCon for call
      • Read vCon for user's call
    • Phones
      • Macs
        • Supported Models and Servers
    • Flow SDK
      • UIExtensions
        • List loadable extensions
        • List registered extensions
        • Register extension
        • Get extension
        • Update extension
        • Delete extension
        • List access rules
        • Create access rule
        • Update access rule
        • Delete access rule
        • List extension versions
        • Get Flow SDK settings
        • Update Flow SDK settings
        • Reanalyze extension versions
        • Deploy extension version
    • Inboxes
      • List inboxes
      • Read inbox
      • List user inboxes
      • Create inbox
      • Rename inbox
      • Delete inbox
      • List inbox members
      • Add inbox member
      • Change inbox member role
      • Remove inbox member
      • Read inbox member
      • Assign SMS number to inbox
      • Remove SMS number 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 domain network test reports
      • Create network test report
      • Read network test report
      • Delete network test report
      • List user network test reports
      • Create user network test report
      • Read user network test report
      • Delete user network test report
      • List network test reports across domains
      • Read network test report across domains
      • Delete network test report across domains
    • SMS Carriers
      • List SMS carriers
      • Create custom SMS carrier
      • Read SMS carrier
      • Update SMS carrier
      • Delete 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 service code
      • Update service code
      • Delete service code
      • Read domain service code
      • Update domain service code
      • Delete domain service code
      • List service codes
      • Create service code
      • Count service codes
      • List domain service codes
      • Create domain service code
      • Count domain service codes
      • List domain service code summaries
    • 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 OAuth client
      • Count OAuth clients
      • Read OAuth client
      • Update OAuth client
      • Delete OAuth client
    • OAuth Tokens
      • List issued tokens
      • Count issued tokens
      • Read issued token
      • Revoke 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 recording storage services
      • List domain recording storage services
      • Create recording storage service
      • Read recording storage service
      • Update recording storage service
      • Delete recording storage service
    • Processes
      • List processes
      • List processes on server
      • Count processes
      • List selected process fields
    • Services
      • List controllable services
      • List services on server
      • Read service status
      • Reload unit files on server
      • Start, stop, or restart service
    • Fax
      • List fax numbers in a domain
      • Create a fax number
      • Read a fax number
      • Update a fax number
      • Delete a fax number
      • List a user's fax numbers
      • Read a user's fax number
      • Update a user's fax number
      • List faxes
      • Send a fax
      • Delete faxes in bulk
      • Read a fax
      • Delete a fax
      • Download the fax document
      • Download a small image of the first page
      • Preview a fax cover page
      • Read the system fax cover page
      • Set the system fax cover page
      • Set the system fax cover page (POST)
      • Delete the system fax cover page
      • Download the system fax cover page
      • Read the reseller fax cover page
      • Set the reseller fax cover page
      • Set the reseller fax cover page (POST)
      • Delete the reseller fax cover page
      • Download the reseller fax cover page
      • Read the domain fax cover page
      • Set the domain fax cover page
      • Set the domain fax cover page (POST)
      • Delete the domain fax cover page
      • Download the domain fax cover page
      • Read the user fax cover page
      • Set the user fax cover page
      • Set the user fax cover page (POST)
      • Delete the user fax cover page
      • Download the user fax cover page
      • Read a domain's fax vendor
      • List fax vendors
    • APNs
      • List APNs apps
      • Add APNs app
      • Count APNs apps
      • Get APNs app
      • Change APNs app
      • Delete APNs app
    • Schemas
      • Schemas
        • Authentication
        • Address
      • Enums
      • securitySchemes
      • Default Folder
        • Inbox
        • InboxMember
        • AuthRequirement
        • NdpServerListItem
        • UserReadAdditions
        • 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
        • DashboardDetail
        • DashboardRequest
        • ChartDetail
        • ChartRequest
        • DomainUpdate
        • UserRead
        • UserCreate
        • UserUpdate
        • BrandListItem
        • BrandCreate
        • BrandUpdate
        • BrandCopy
        • BrandAssetCreate
        • BrandAssetCreateMultipart
        • BrandAssetUpdate
        • BrandAssetUpdateMultipart
        • PhonenumberCreate
        • PhonenumberUpdate
        • PhonenumberUpdateInBody
        • CallQueueStatistics
        • AgentStatistics
        • DnisStatistics
        • AgentStatusTime
        • CallQueueStatisticsByQueue
        • AgentStatisticsByAgent
        • DnisStatisticsByNumber
        • AgentStatusTimeByAgent
        • CallQueueStatisticsByInterval
        • AgentStatisticsByInterval
        • DnisStatisticsByInterval
        • CallQueueStatisticsResult
        • CallQueueStatisticsPerQueueResult
        • AgentStatisticsListResult
        • AgentStatisticsResult
        • DnisStatisticsResult
        • AddressCreate
        • AddressUpdate
        • AddressValidateRequest
        • AddressEndpointWrite
        • AddressEndpointDelete
        • PhoneTemplateSummary
        • PhoneTemplateCreate
        • PhoneTemplateUpdate
        • PhoneConfigurationCreate
        • PhoneConfigurationUpdate
        • DeviceProfileUpdate
        • TranslationCreateItem
        • TranslationCreateRequest
        • TranslationUpdateItem
        • TranslationUpdateRequest
        • TranslationDeleteItem
        • TranslationDeleteRequest
        • TranslationUpdateResponse
        • TranslationDeleteResponse
        • TranslationCreateResult
        • TranslationUpdateResult
        • TranslationDeleteResult
        • TranslationsByNamespace
        • TranslationsFlat
        • TranslationDescriptions
        • TranslationSyncRequest
        • TranslationSyncSummary
        • TranslationSyncResponse
        • FlowSdkExtensionCreate
        • FlowSdkExtensionUpdate
        • FlowSdkAccessRuleWrite
        • FlowSdkAccessRuleCreated
        • FlowSdkRulePolicyOverride
        • FlowSdkSettingsUpdate
        • FlowSdkReanalyzeRequest
        • FlowSdkDeployRequest
        • FlowSdkVerificationReport
        • FlowSdkDeployResult
        • FlowSdkVersionList
        • InboxCreate
        • InboxUpdate
        • InboxMemberAdd
        • InboxMemberRole
        • UserInbox
        • MessageSendRequest
        • MessagesessionUpdate
        • MessagesessionAccept
        • SmsBlockCreate
        • SmsBlockUpdate
        • CustomScopeCreate
        • CustomScopeUpdate
        • OIDCProviderUpdate
        • OIDCProviderRead
        • OIDCProviderPublic
        • OIDCProviderVerify
        • OIDCProviderVerifyResult
        • OIDCProviderLogoResult
        • UserEmailCallCenterReport
        • UserEmailAccount
        • UserEmailCustomTemplate
        • UserEmailLostAuthenticator
        • UserEmailVerification
        • SendUserEmailRequest
        • SendUserEmailResult
        • EmailVerifyResult
        • EmailValidateResult
        • EmailVerifiedStatus
        • FirebaseServiceAccount
        • FirebaseServiceAccountCreate
        • ResellerPath
        • DialplanPath
        • DialpolicyPath
        • HostnamePath
        • IpawareHostnamePath
        • Synchronous
        • SynchronousTimeout
        • IncludeSecrets
        • 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
        • RouteProfileCreate
        • EmailValidate
        • Avatar
        • RouteProfileUpdate
        • OIDCProvider
        • SmsBlock
        • ConnectionCreate
        • SSOEnroll
        • DomainConnectionCreate
        • AbandondedCallStat
        • Phoneconfiguration
        • ConnectionUpdate
        • PhoneConfigBtn
        • QueueStat
        • CdrCount
        • Auditlog
        • CdrUpdate
        • InsightValue
        • Holiday
        • CdrScheduleListItem
        • DeviceModelButtonType
        • DeviceModel
        • ResellerUpdate
        • DeviceImage
        • DeviceProfile
        • SiteCreateRequest
        • DeviceProfileButton
        • SiteUpdateRequest
        • Dialpolicy
        • Permission
        • SubscriptionCreate
        • DispositionReason
        • SubscriptionUpdate
        • PublicUserInfo
        • RouteConnection
        • TimeframeSpecificDateNew
        • Route
        • Presence
        • TimeframeDOWNew
        • Dashboard
        • TimeframeHolidayNew
        • Chart
        • AnswerruleFeatureSimRing
        • TimeframeCreateAlways
        • ConferenceCDR
        • Conference
        • TimeframeCreateDaysOfWeek
        • ConferenceParticipant
        • Dialplan
        • TimeframeCreateSpecificDates
        • NumberEnabledMap
        • TimeframeCreateHoliday
        • Certficate
        • Start
        • TimeframeCreateCustom
        • Limit
        • TimeframeCreateRequest
        • Transcription
        • 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
      • CDR Schedule
        • CdrExport
      • LicfConfigApplied
      • DomainTemplate
      • DomainSetting
      • LicfConfig
      • ProcessR
      • DeviceListItem
      • ErrorResponse
      • PhonenumberListItem
      • Department
      • ContactListItem
      • SipServers
      • DefaultR
      • NmsConfig
      • Park
      • SpeechWordR
      • IpawareError
      • UsersettingValue
      • ConferenceListItem
      • ActiveCall
      • Recordingserver
      • NetworktestR
      • ServiceCode
      • OauthClient
      • FlowSdkAccessRule
      • SmscarrierFields
      • FaxError
      • ApnsApp
      • EmailReportType
      • TemplateVariable
      • SiteWrite
      • DomainSettingCatalog
      • NmcConfig
      • CountResponse
      • DialruleListItem
      • CdrSchedule
      • SipServer
      • DefaultC
      • NmsConfigListItem
      • ParkWrite
      • SpeechWordU
      • IpawareValidationError
      • UsersettingR
      • RecordingserverWrite
      • AttendantListItem
      • NetworktestReport
      • ServiceCodeCreate
      • OauthClientCreate
      • AddressListItem
      • FlowSdkAnalysisDenylist
      • SmscarrierR
      • FaxNumber
      • ApnsAppCreate
      • EmailReportFrequency
      • DomainTemplateProvisionRequest
      • DomainSettingCatalogEntry
      • LicfConfigWrite
      • QuotaCreate
      • ConnectionListItem
      • CdrScheduleInput
      • CdrScheduleUpdate
      • SipServerSrv
      • DefaultU
      • NmsConfigServer
      • ParkListItem
      • SpeechWordRender
      • IpawareAllowedIpAdd
      • PushListItem
      • UsersettingC
      • RecordingCoreserver
      • ServiceCodeKeyedUpdate
      • ServicecodeListItem
      • OauthClientUpdate
      • FlowSdkExtension
      • FlowSdkAnalysisSettings
      • SmscarrierC
      • FaxNumberWrite
      • ApnsAppUpdate
      • EmailReportQueueStatistic
      • DomainTemplateProvisionResponse
      • DomainSettingEffective
      • LicfConfigUpdate
      • SuccessResponse
      • TimeframeListItem
      • AgentListItem
      • DefaultListItem
      • NmsConfigVerify
      • SpeechWordUpload
      • SpeechWordBulkRender
      • IpawareAllowedIpRemove
      • UsersettingU
      • Recordingentry
      • ServiceCodeKeyedDelete
      • OauthClientWithSecret
      • FlowSdkCspCoverage
      • SmscarrierPortalR
      • Fax
      • EmailReportAgentStatistic
      • DomainSettingValue
      • LicfConfigServer
      • DialpolicyListItem
      • RecordingentryWrite
      • NmsConfigCreate
      • AnswerruleListItem
      • SpeechWordBulkResult
      • IpawareAllowedIpMutationResult
      • DomainServiceCodeCreate
      • DispositionListItem
      • OauthToken
      • SmscarrierBuiltinU
      • FaxCoverPageFields
      • EmailReportUpdate
      • DomainSettingWrite
      • ArchiveConfig
      • PermissionListItem
      • NmsConfigUpdate
      • IpawareAllowEntry
      • ParticipantListItem
      • RecordingentrySyncRequest
      • MeetingListItem
      • DomainServiceCodeKeyedUpdate
      • FlowSdkExtensionRuntime
      • SmscarrierCustomU
      • FaxCoverPage
      • EmailReport
      • ArchiveConfigWrite
      • NmsConfigCount
      • SpeechwordListItem
      • IpawareAllowedIpsList
      • UsersettingListItem
      • RecordingentrySyncResult
      • FlowSdkSettings
      • FaxCoverPageUpload
      • EmailReportSchedule
      • ArchiveConfigUpdate
      • SubscriptionListItem
      • NmsSuccessResponse
      • IpawarePendingChange
      • RecordingentrySyncFailure
      • FlowSdkExtensionVersion
      • FaxSend
      • RecordingStorage
      • NmsErrorResponse
      • IpawareConfigState
      • RecordingentrySyncAccepted
      • FlowSdkReanalyzeEntry
      • FaxVendorDomain
      • RecordingStorageWrite
      • IpawareConfigKeyState
      • RecordingentrySyncJob
      • FlowSdkReanalyzeResult
      • FaxVendor
      • RecordingStorageUpdate
      • IpawareConfigUpdateResult
      • FlowSdkRulePolicy
      • Quota
      • IpawareStatusZ
      • FlowSdkRulePolicyEntry
      • QuotaWrite
      • IpawareBlockEntry
      • LicfSuccessResponse
      • IpawareFirewallState
      • LicfErrorResponse
      • IpawareFirewallBlockRequest
      • IpawareFirewallUnblockRequest
      • IpawareFirewallOpResult
      • RecordNotFound
      • BadRequest
      • AuthenticationRequired
  • Notification Center and voice usage (net-new endpoints)
    • Voice usage
      • Read voice usage
      • Read voice usage for domain
      • Read voice usage summary
      • Read voice usage summary for domain
      • Read voice usage time series
      • Read voice usage time series for domain
      • Read voice usage by domain
      • Read voice usage by domain for domain
      • Read voice usage by user
      • Read voice usage by user for domain
      • Read voice usage enhancements
      • Read voice usage enhancements for domain
      • Read voice usage features
      • Read voice usage features for domain
    • Notices
      • List notices
      • Create notice
      • Get notice
      • Update notice
      • Delete notice
      • List active notices for the caller
      • List active notices for a user
      • Mark notice seen
    • Notifications
      • List notifications for a user
      • Mark notification read
      • Mark all notifications read
      • Hide notification for user
      • Hide all notifications for user
      • Read notification preferences
      • Update notification preferences
      • Create notification (internal)
    • Schemas
      • Error
      • VoiceUsageReport
      • VoiceUsageSummaryReport
      • VoiceUsageTimeseriesReport
      • VoiceUsageByDomainReport
      • VoiceUsageByUserReport
      • VoiceUsageEnhancementsReport
      • VoiceUsageFeaturesReport
      • Notice
      • NoticeActive
      • NoticeList
      • NoticeActiveList
      • CreateNoticeBody
      • UpdateNoticeBody
      • Accepted
      • Notification
      • NotificationFeed
      • MarkReadResult
      • DeleteAllResult
      • NotificationPreferences
      • UpdateNotificationPreferencesBody
      • CreateNotificationBody
  1. Phones/Macs

Read phone in domain

Testing
GET
/domains/{domain}/phones/{mac}
Last modified:2026-10-08 23:11:05
OperationId:ReadPhoneInDomain
Reads one phone in the domain with its full detail: every line, the model's capabilities, line 1's registration, and the Endpoints server hostname. Super User, Reseller, and Office Manager read any phone they can see. Site Manager reads phones whose line 1 belongs to a user in its site. Basic User and the other user scopes read only their own phone, the one whose line 1 they own.
Per-line passwords are left out, and device-provisioning-password is masked except on your own phone. A Super User can send include-secrets=yes to get them in plaintext. The reveal is audit-logged.
Two fields describe a sidecar (expansion module): device-provisioning-sidecar is this phone's own setting, and device-models-sidecar-support-enabled is whether its model supports one. A phone's own configuration overrides are returned as device-provisioning-overrides-blob. The same value is also returned as device-models-overrides-blob, which is deprecated and will be removed in the next release. A phone in another domain returns 404.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Query Params

Responses

🟢200OK
application/json
The phone.
Bodyapplication/json

🟠401Authentication Required
🟠403Forbidden
🟠404Record not found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//phones/00005e005301?include-secrets=no' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Phone
{
    "device-provisioning-mac-address": "00005e005301",
    "domain": "example.com",
    "reseller": "example-reseller",
    "device-models-brand-and-model": "Yealink T54W",
    "device-provisioning-registration-core-server": "core1.example.com",
    "notes": "Front Desk",
    "device-provisioning-sip-uri-1": "sip:1001a@example.com",
    "device-provisioning-line-1-enabled": "yes",
    "device-provisioning-sip-uri-1-shared-line-enabled": "private",
    "device-provisioning-sip-uri-2": "n/a",
    "device-provisioning-line-2-enabled": "no",
    "device-provisioning-sip-uri-2-shared-line-enabled": "private",
    "device-provisioning-sip-transport-protocol": "udp",
    "device-provisioning-username": "00005e005301",
    "device-provisioning-password": "s3********99",
    "device-models-count-buttons": 16,
    "device-models-fxs-support-enabled": 0,
    "device-provisioning-overrides-blob": "",
    "device-models-overrides-blob": "",
    "device-models-resync-support-enabled": "yes",
    "device-models-shared-line-support-enabled": "yes",
    "device-models-sidecar-support-enabled": "yes",
    "device-provisioning-last-retrieved-datetime": "2026-10-01T10:37:51+00:00",
    "device-provisioning-directory": "disabled",
    "device-provisioning-directory-support": "yes",
    "device-provisioning-line-1-extensions": "1001a",
    "device-provisioning-line-2-extensions": "",
    "device-provisioning-ndp-hostname": "ndp1.example.com",
    "device-provisioning-presence": "enabled",
    "created-datetime": "2026-09-22T18:22:19+00:00",
    "global-one-time-pass": "no",
    "redundency": "system default",
    "device-provisioning-sidecar": "no",
    "device-provisioning-srtp": "no",
    "device-provisioning-encryption": "disabled",
    "device-provisioning-outbound-proxy-port": "5060",
    "device-provisioning-local-port": "5060",
    "device-sip-registration-contact": "<sip:1001a@192.0.2.10:5060>",
    "device-sip-registration-datetime": "2026-10-02T18:12:12+00:00",
    "device-sip-registration-expires-datetime": "2026-10-02T18:24:12+00:00",
    "device-sip-registration-state": "registered",
    "device-sip-registration-user-agent": "Yealink SIP-T54W 96.86.0.100",
    "user": "1001"
}
Modified at 2026-10-08 23:11:05
Previous
Read phone
Next
Add phone
Built with