- Version
- Authentication
- Access Token (Oauth - Username/Password)
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- NetsapiensJs Auth
- Masquerade
- Resellers
- Phone Numbers
- destination-application mappings and parameter parsing
- List phone numbersGET
- Create phone numberPOST
- Count phone numbersGET
- List phone numbers in all domainsGET
- Count phone numbers in all domainsGET
- Delete phone numberDELETE
- Update phone numberPUT
- Read phone numberGET
- List phone numbers (short)GET
- Update phone number by bodyPUT
- 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
- Supported Models and Servers
- SnapBuilder
- Event Subscriptions
- Domains
- Users
- 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
- Call Center
- Callqueues
- Agents
- Agent Actions
- QueuedCalls
- 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
- Answer Rules
- 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
- Auto Attendant
- Media
- CDR (Call History)
- 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
- 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
- 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
- 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 Numbers
- Recordings
- Email
- Connections
- Routes
- Route Profiles
- Meetings
- Event Logs
- 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
- Configs
- Configurations
- NS Configs
- NMS Configs
- 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
- Read configuration
- List configurations
- Count configurations
- Create configuration
- Update configuration
- Delete configuration
- Configuration Definitions
- Configurations
- Images
- Templates
- Timeframes
- Firebase
- SSL Certificates
- 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
- Conference
- Charts
- 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
- Presence
- Audit Log
- Access Log
- Avatars
- Generic
- 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
- License
- Reject Log
- 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
- Brands
- Brand Assets
- vCon
- Phones
- 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
- UIExtensions
- Inboxes
- 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
- 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
- ipaware
- 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
- OAuth Tokens
- Domain Templates
- Call Parks
- Call Queues
- NMS Status
- Custom Scopes
- Domain Settings
- Recording Storage
- Processes
- Services
- 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
- Schemas
- Schemas
- 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
- Authentication
- NMS Status
- Custom Scopes
- CDR (Call History)
- 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
- 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
- TemplateVariable
- SiteWrite
- DomainSettingCatalog
- NmcConfig
- CountResponse
- DialruleListItem
- CdrSchedule
- SipServer
- DefaultC
- NmsConfigListItem
- ParkWrite
- SpeechWordU
- IpawareValidationError
- UsersettingR
- RecordingserverWrite
- AttendantListItem
- NetworktestReport
- ServiceCodeCreate
- OauthClientCreate
- AddressListItem
- FlowSdkAnalysisDenylist
- SmscarrierR
- FaxNumber
- ApnsAppCreate
- DomainTemplateProvisionRequest
- DomainSettingCatalogEntry
- LicfConfigWrite
- QuotaCreate
- ConnectionListItem
- CdrScheduleInput
- CdrScheduleUpdate
- SipServerSrv
- DefaultU
- NmsConfigServer
- ParkListItem
- SpeechWordRender
- IpawareAllowedIpAdd
- PushListItem
- UsersettingC
- RecordingCoreserver
- ServiceCodeKeyedUpdate
- ServicecodeListItem
- OauthClientUpdate
- FlowSdkExtension
- FlowSdkAnalysisSettings
- SmscarrierC
- FaxNumberWrite
- ApnsAppUpdate
- DomainTemplateProvisionResponse
- DomainSettingEffective
- LicfConfigUpdate
- SuccessResponse
- TimeframeListItem
- AgentListItem
- DefaultListItem
- NmsConfigVerify
- SpeechWordUpload
- SpeechWordBulkRender
- IpawareAllowedIpRemove
- UsersettingU
- Recordingentry
- ServiceCodeKeyedDelete
- OauthClientWithSecret
- FlowSdkCspCoverage
- SmscarrierPortalR
- Fax
- DomainSettingValue
- LicfConfigServer
- DialpolicyListItem
- RecordingentryWrite
- NmsConfigCreate
- AnswerruleListItem
- SpeechWordBulkResult
- IpawareAllowedIpMutationResult
- DomainServiceCodeCreate
- DispositionListItem
- OauthToken
- SmscarrierBuiltinU
- FaxCoverPageFields
- DomainSettingWrite
- ArchiveConfig
- PermissionListItem
- NmsConfigUpdate
- IpawareAllowEntry
- ParticipantListItem
- RecordingentrySyncRequest
- MeetingListItem
- DomainServiceCodeKeyedUpdate
- FlowSdkExtensionRuntime
- SmscarrierCustomU
- FaxCoverPage
- ArchiveConfigWrite
- NmsConfigCount
- SpeechwordListItem
- IpawareAllowedIpsList
- UsersettingListItem
- RecordingentrySyncResult
- FlowSdkSettings
- FaxCoverPageUpload
- 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
List NMS status metrics
GET
/nmsstatus/metrics
Last modified:2026-10-07 23:39:13
OperationId:ListNmsStatusMetrics
GET /nmsstatus can return, with each metric's ID, type, unit, group, and display label. Requires Super User or Super User Read Only scope.type or group. Use the metric values in the metrics parameter of GET /nmsstatus.Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Query Params
Responses
🟢200OK
application/json
Bodyapplication/json
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/nmsstatus/metrics?type=gauge&group=sessions' \
--header 'Authorization: Bearer <token>'Response Response Example
200 - Sessions group
group=sessions, first rows shown.[
{
"metric": "session-connected",
"column": "session_connected",
"type": "gauge",
"unit": "sessions",
"series-unit": "sessions",
"group": "sessions",
"label": "Sessions connected (active calls)"
},
{
"metric": "session-answered",
"column": "session_answered",
"type": "counter",
"unit": "sessions",
"series-unit": "sessions/s",
"group": "sessions",
"label": "Sessions answered"
},
{
"metric": "min-ans",
"column": "min_ans",
"type": "counter",
"unit": "minutes",
"series-unit": "minutes/s",
"group": "sessions",
"label": "Minutes answered"
}
]Modified at 2026-10-07 23:39:13