List of API Endpoints

This topic lists the API endpoints supported by NovoOne.

API authentication


Function	HTTP Method	API Endpoint
Get an Access Token	POST	/api/v1/oauth2/token

Login


Function	HTTP Method	API Endpoint
Get a Captcha for Login	GET	/uc-auth/api/v1/public/captcha
Refresh a Captcha for Login	POST	/uc-auth/api/v1/public/captcha/refresh
Query QR Code for NovoOne Mobile Client Login	GET	/uc-auth/api/v1/auth/qr-login-codes/current
Generate a QR Code for NovoOne Mobile Client Login	POST	/uc-auth/api/v1/auth/qr-login-codes

Dashboard


Function	HTTP Method	API Endpoint
Get Dashboard Overview	GET	/uc-dashboard/api/v1/dashboard/overview
Query Call Trend	POST	/uc-dashboard/api/v1/dashboard/trends/call
Query Peak Concurrent Trend	POST	/uc-dashboard/api/v1/dashboard/trends/concurrent
Query Trunk Capacity Trend	POST	/uc-dashboard/api/v1/dashboard/trends/trunk-capacity
Query Tenant Resource Usage and Capacity	GET	/uc-dashboard/api/v1/dashboard/tenant/usage
Query Concurrent Call Statistics	POST	/uc-ccontrol/api/v1/call-sessions/concurrent-stats

Subscription


Function	HTTP Method	API Endpoint
Get Subscription Information	GET	/uc-subscription/api/v1/subscription
Query Capacity Allocation for Resellers	GET	/uc-subscription/api/v1/subscription/usage/reseller-colleague
Query Capacity Allocation for Own Tenants	GET	/uc-subscription/api/v1/subscription/usage/self-colleague
Get Capacity Summary of a Company	GET	/uc-subscription/api/v1/subscription/quota-summary
Get Capacity Usage of a Tenant	GET	/uc-subscription/api/v1/subscription/tenant/`{tenantId}`

Account


Function	HTTP Method	API Endpoint
Get Account Preferences	GET	/uc-user/api/v1/preferences/me
Update Account Preferences	PUT	/uc-user/api/v1/preferences/me

Contacts


Function	HTTP Method	API Endpoint
Company Contacts
Get a Company Contact	GET	/uc-ccontact/api/v1/company-contacts/`{id}`
Get Company Contact Quota	GET	/uc-ccontact/api/v1/company-contacts/quota
Search Company Contacts	POST	/uc-ccontact/api/v1/company-contacts/search-page
Check for Duplicate Company Contacts	POST	/uc-ccontact/api/v1/company-contacts/check-duplicate
Add a Company Contact	POST	/uc-ccontact/api/v1/company-contacts
Update a Company Contact	PUT	/uc-ccontact/api/v1/company-contacts/`{id}`
Import Company Contacts	POST	/uc-ccontact/api/v1/company-contacts/import
Export Company Contacts	POST	/uc-ccontact/api/v1/company-contacts/export
Clear Company Contacts	POST	/uc-ccontact/api/v1/company-contacts/clear
Bulk Delete Company Contacts	DELETE	/uc-ccontact/api/v1/company-contacts
Personal Contacts
Get a Personal Contact	GET	/uc-ccontact/api/v1/personal-contacts/`{id}`
Get Personal Contact Quota	GET	/uc-ccontact/api/v1/personal-contacts/quota
Search Personal Contacts	POST	/uc-ccontact/api/v1/personal-contacts/search-page
Check for Duplicate Personal Contacts	POST	/uc-ccontact/api/v1/personal-contacts/check-duplicate
Add a Personal Contact	POST	/uc-ccontact/api/v1/personal-contacts
Add a Phone Number to a Personal Contact	POST	/uc-ccontact/api/v1/personal-contacts/add-phone
Update a Personal Contact	PUT	/uc-ccontact/api/v1/personal-contacts/`{id}`
Import Personal Contacts	POST	/uc-ccontact/api/v1/personal-contacts/import
Export Personal Contacts	POST	/uc-ccontact/api/v1/personal-contacts/export
Clear Personal Contacts	POST	/uc-ccontact/api/v1/personal-contacts/clear
Bulk Delete Personal Contacts	DELETE	/uc-ccontact/api/v1/personal-contacts
Common APIs - Search
Query Contacts Directory	POST	/uc-ccontact/api/v1/personal-contacts/list-basic
Get Contact Details	GET	/uc-ccontact/api/v1/contacts/detail/`{id}`
Search Contacts from Dialpad	POST	/uc-ccontact/api/v1/personal-contacts/dial-search
Search Contacts from Search Bar	POST	/uc-ccontact/api/v1/web/top-search
Match a Phone Number to a Contact	POST	/uc-ccontact/api/v1/contacts/match-phone
Common APIs - Favorites
Add Contacts to Favorites	POST	/uc-ccontact/api/v1/contacts/favorites/batch
Remove Contacts from Favorites	DELETE	/uc-ccontact/api/v1/contacts/favorites/batch
Common APIs - Import
Get Contact Upload Credentials	POST	/uc-ccontact/api/v1/resources/upload-credential
Common APIs - Synchronization
Synchronize Contacts to Mobile Client	POST	/uc-ccontact/api/v1/contacts/sync
Common APIs - Task
Query Task List	POST	/uc-ccontact/api/v1/tasks/list
Get a Task	GET	/uc-ccontact/api/v1/tasks/`{id}`
Download a Task File	GET	/uc-ccontact/api/v1/tasks/`{taskId}`/export-download-url
Confirm Tasks	POST	/uc-ccontact/api/v1/tasks/confirm

Tenant


Function	HTTP Method	API Endpoint
Query Tenants	POST	/uc-tenant/api/v1/tenants/search-page
Get Tenant Details	GET	/uc-tenant/api/v1/tenants/`{tenantId}`
Add a Tenant	POST	/uc-tenant/api/v1/tenants
Update a Tenant	PUT	/uc-tenant/api/v1/tenants/`{id}`
Delete a Tenant	DELETE	/uc-tenant/api/v1/tenants/`{id}`
Bulk Delete Tenants	DELETE	/uc-tenant/api/v1/tenants/batch-delete

SIP Trunks


Function	HTTP Method	API Endpoint
STIR/SHAKEN
Get STIR/SHAKEN Settings	GET	/uc-cconfig/api/v1/stirshaken/setting
Update STIR/SHAKEN Settings	PUT	/uc-cconfig/api/v1/stirshaken/setting
Get Custom Verification Statuses of a Trunk	GET	/uc-cconfig/api/v1/trunks/{trunkId}/extra/dcvs_custom_options
Update Custom Verification Statuses of a Trunk	PUT	/uc-cconfig/api/v1/trunks/{trunkId}/extra/dcvs_custom_options

Emergency Number

Emergency Number


Function	HTTP Method	API Endpoint
Query an Emergency Number	GET	/uc-cconfig/api/v1/emergency-numbers/`{id}`
Query Emergency Numbers for NovoOne Mobile Client	POST	/uc-cconfig/api/v1/emergency-numbers/app-query
Query Users for Emergency Numbers	GET	/uc-cconfig/api/v1/emergency-numbers/users
Query Trunks for Emergency Numbers	GET	/uc-cconfig/api/v1/emergency-numbers/trunks
Check for Duplicate Emergency Numbers	POST	/uc-cconfig/api/v1/emergency-numbers/validate
Search Emergency Numbers	POST	/uc-cconfig/api/v1/emergency-numbers/search-page
Add an Emergency Number	POST	/uc-cconfig/api/v1/emergency-numbers
Update an Emergency Number	PUT	/uc-cconfig/api/v1/emergency-numbers/`{id}`
Delete an Emergency Number	DELETE	/uc-cconfig/api/v1/emergency-numbers/`{id}`
Bulk Delete Emergency Numbers	DELETE	/uc-cconfig/api/v1/emergency-numbers/batch

Notification Contacts


Function	HTTP Method	API Endpoint
Query an Emergency Contact	GET	/uc-cconfig/api/v1/emergency-contacts/`{id}`
Search Emergency Contacts	POST	/uc-cconfig/api/v1/emergency-contacts/search-page
Add an Emergency Contact	POST	/uc-cconfig/api/v1/emergency-contacts
Update an Emergency Contact	PUT	/uc-cconfig/api/v1/emergency-contacts/`{id}`
Delete an Emergency Contact	DELETE	/uc-cconfig/api/v1/emergency-contacts/`{id}`
Bulk Delete Emergency Contacts	DELETE	/uc-cconfig/api/v1/emergency-contacts/batch

AI

Summary Template


Function	HTTP Method	API Endpoint
Search Summary Templates	POST	/uc-ai/api/v1/summary-templates/search-page
Get the Default Summary Template	GET	/uc-ai/api/v1/summary-templates/default
Set the Default Summary Template	PUT	/uc-ai/api/v1/summary-templates/default
Get a Summary Template	GET	/uc-ai/api/v1/summary-templates/`{id}`
Query Summary Templates	GET	/uc-ai/api/v1/summary-templates
Add a Summary Template	POST	/uc-ai/api/v1/summary-templates
Duplicate a Summary Template	POST	/uc-ai/api/v1/summary-templates/`{id}`/duplicate
Update a Summary Template	PUT	/uc-ai/api/v1/summary-templates/`{id}`
Delete a Summary Template	DELETE	/uc-ai/api/v1/summary-templates/`{id}`

Call Features

Voicemail


Function	HTTP Method	API Endpoint
Tenant Voicemail
Get Global Voicemail Setting	GET	/uc-cconfig/api/v1/voicemail/global-settings
Update Global Voicemail Setting	PUT	/uc-cconfig/api/v1/voicemail/global-settings
Client Voicemail
Search Voicemails	POST	/uc-creport/api/v1/my-voicemails/search-page
Query Voicemail Unread Count	GET	/uc-creport/api/v1/my-voicemails/unread-count
Update Voicemail Read Status	PUT	/uc-creport/api/v1/my-voicemails/`{id}`/read-status
Bulk Update Voicemail Read Status	PUT	/uc-creport/api/v1/my-voicemails/batch/read-status
Bulk Forward Voicemails	POST	/uc-creport/api/v1/my-voicemails/batch/forward
Get a Voicemail File URL	GET	/uc-creport/api/v1/my-voicemails/`{id}`/url
Trigger a Voicemail Transcription	POST	/uc-creport/api/v1/my-voicemails/`{id}`/transcription
Delete a Voicemail	DELETE	/uc-creport/api/v1/my-voicemails/`{id}`
Bulk Delete Voicemails	DELETE	/uc-creport/api/v1/my-voicemails/batch
Clear Voicemails	DELETE	/uc-creport/api/v1/my-voicemails

Feature Code


Function	HTTP Method	API Endpoint
Get Feature Code Setting	GET	/uc-cconfig/api/v1/feature-codes
Update Feature Code Setting	PUT	/uc-cconfig/api/v1/feature-codes

IVR


Function	HTTP Method	API Endpoint
Get an IVR	GET	/uc-cconfig/api/v1/ivrs/`{id}`
Get Available Outbound Routes for IVRs	GET	/uc-cconfig/api/v1/ivrs/outbound-routes
Get Available Queues for IVRs	GET	/uc-cconfig/api/v1/ivrs/queues
Get Available Ring Groups for IVRs	GET	/uc-cconfig/api/v1/ivrs/ring-groups
Get Available Users for IVRs	GET	/uc-cconfig/api/v1/ivrs/users
Get Available IVRs for IVRs	GET	/uc-cconfig/api/v1/ivrs/ivrs
Get Default IVR Extension	GET	/uc-cconfig/api/v1/ivrs/defaults
Search IVRs	POST	/uc-cconfig/api/v1/ivrs/search-page
Add an IVR	POST	/uc-cconfig/api/v1/ivrs
Update an IVR	PUT	/uc-cconfig/api/v1/ivrs/`{id}`
Delete an IVR	DELETE	/uc-cconfig/api/v1/ivrs/`{id}`
Bulk Delete IVRs	DELETE	/uc-cconfig/api/v1/ivrs/batch

PIN List


Function	HTTP Method	API Endpoint
Get PIN List	GET	/uc-cconfig/api/v1/pin-lists/`{id}`
Search PIN Lists	POST	/uc-cconfig/api/v1/pin-lists/search-page
Check PIN List Usage	POST	/uc-cconfig/api/v1/pin-lists/used-check
Check for Duplicate PIN Lists	POST	/uc-cconfig/api/v1/pin-lists/validate
Add a PIN List	POST	/uc-cconfig/api/v1/pin-lists
Update a PIN List	PUT	/uc-cconfig/api/v1/pin-lists/`{id}`
Delete a PIN List	DELETE	/uc-cconfig/api/v1/pin-lists/`{id}`
Bulk Delete PIN Lists	DELETE	/uc-cconfig/api/v1/pin-lists/batch

System

Preferences


Function	HTTP Method	API Endpoint
Get Country List	GET	/uc-tenant/api/v1/country
Get Time Zone List	GET	/uc-tenant/api/v1/time-zone
Get Tone Region List (Platform-Level)	GET	/uc-tenant/api/v1/tone-region
Get Tone Region List (Tenant-Level)	GET	/uc-cconfig/api/v1/preferences/tone-regions
Get Tenant Preferences	GET	/uc-cconfig/api/v1/preferences
Update System Preference for a Tenant	PUT	/uc-cconfig/api/v1/preferences

SIP Settings - Codec


Function	HTTP Method	API Endpoint
Get Codec Options	GET	/uc-cconfig/api/v1/sip-setting/codec-options
Get Codec Setting	GET	/uc-cconfig/api/v1/sip-setting/codec
Update Codec Setting	PUT	/uc-cconfig/api/v1/sip-setting/codec

Event Notification


Function	HTTP Method	API Endpoint
Get Alarm Settings for the Platform	GET	/uc-notification/api/v1/alarm/settings
Update Alarm Setting for the Platform	PUT	/uc-notification/api/v1/alarm/settings/`{eventCode}`
Query Events for a Tenant	GET	/uc-notification/api/v1/event-notification/event-types
Update Event Settings for a Tenant	PUT	/uc-notification/api/v1/event-notification/event-types/`{eventCode}`

Domain


Function	HTTP Method	API Endpoint
Get Available Regions	GET	/uc-user/api/v1/domains/available-regions
Get a Domain Deletion Captcha	GET	/uc-user/api/v1/domains/regions/`{region}`/captcha
Check Domain DNS Records	POST	/uc-user/api/v1/domains/regions/`{region}`/dns-check
Preview Domain DNS Records	POST	/uc-user/api/v1/domains/regions/`{region}`/dns-preview
Search Domains	POST	/uc-user/api/v1/domains/search-page
Get a Domain	GET	/uc-user/api/v1/domains/regions/`{region}`/`{id}`
Add a Domain	POST	/uc-user/api/v1/domains/regions/`{region}`
Update a Domain	PUT	/uc-user/api/v1/domains/regions/`{region}`/`{id}`
Delete a Domain	DELETE	/uc-user/api/v1/domains/regions/`{region}`/`{id}`

API


Function	HTTP Method	API Endpoint
Get API Setting	GET	/uc-user/api/v1/system/api-config
Update API Setting	PUT	/uc-user/api/v1/system/api-config
Get Client Secret	POST	/uc-user/api/v1/system/api-config/secret/view
Regenerate Client Secret	POST	/uc-user/api/v1/system/api-config/secret/regenerate

Security

Two-Factor Authentication (2FA)


Function	HTTP Method	API Endpoint
2FA for Email
Send an Email Verification Code for 2FA Setup	POST	/uc-auth/api/v1/mfa/email/send-code
Verify 2FA Setup with Email	POST	/uc-auth/api/v1/mfa/email/verify
Send an Email Verification Code for 2FA Login	POST	/uc-auth/api/v1/public/mfa/email-code
2FA for Authentication App
Generate an Authenticator Secret for 2FA	POST	/uc-auth/api/v1/mfa/authenticator/setup
Verify 2FA Setup with Authenticator App	POST	/uc-auth/api/v1/mfa/authenticator/verify
Cancel 2FA Setup with Authenticator	POST	/uc-auth/api/v1/mfa/authenticator/cancel
Common APIs - Trusted Device
Query Trusted Devices	GET	/uc-auth/api/v1/mfa/trusted-devices
Delete a Trusted Device	POST	/uc-auth/api/v1/mfa/trusted-devices/delete
Query 2FA Setting	GET	/uc-auth/api/v1/mfa/status
Query Ticket Status for 2FA Login	POST	/uc-auth/api/v1/public/mfa/ticket-status
Disable 2FA	POST	/uc-auth/api/v1/mfa/disable

File Upload


Function	HTTP Method	API Endpoint
Upload Files to Public Storage	POST	/uc-resources/api/v1/system/file
Upload Files to Public Storage	POST	/uc-resources/api/v1/system/file/confirm