TIPS API v2
  1. API Key (Machine 2 Machine)
  • Version
    • Read API Version
      GET
  • Authentication
    • Access Token (Oauth - Username
      • Password)
        • Get Access Token From Auth Code
        • Get Access Token From Refresh
        • Get Access Token after MFA include Passcode
        • Get Access Token after MFA request
        • SSO Enroll
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
        GET
      • Read API Keys under your account
        GET
      • Read Info on specific APIKey via Key ID
        GET
      • Update API Key
        PUT
      • Revoke API Key
        DELETE
      • Create API Key
        POST
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Revoke current JWT
      • Read Current JWT
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
  • Event Subscriptions
    • Read Event Subscriptions
      GET
    • Create a Event Subscription
      POST
    • Read Event Subscriptions for Domain
      GET
    • Create a Event Subscription for Domain
      POST
    • Read Event Subscription By Id
      GET
    • Update an Event Subscription
      PUT
    • Delete a subscription
      DELETE
    • Update an Event Subscription for Domain
      PUT
    • Delete a subscription For Domain
      DELETE
  • Resellers
    • Get Resellers
      GET
    • Create Reseller
      POST
    • Count Resellers
      GET
    • Update Reseller
      PUT
    • Delete Reseller
      DELETE
    • Get Specific Reseller
      GET
  • Domains
    • Get Domains
    • Create a Domain
    • Count Domains
    • Get Specific Domain
    • Update a Domain
    • Delete a Domain
    • Get Specific Domain With Billing Summary
    • Get My Domain Info
    • Check if Domain Exists
  • Phone Numbers
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Count All Phone Numbers for System or Reseller
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Users
    • Get Users in Domain
    • Create User in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
    • List Basic Info on Users in Domain
  • Devices
    • Get Devices for User
    • Create Device for User
    • Count Devices for Domain
    • Count Devices for Reseller
    • Count Devices for User
    • Count Devices by Device
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
    • Get Devices in Domain
  • Phones
    • Macs
      • Supported Models and Servers
        • Get list of Supported/Provisionable Models
        • Get list of Supported/Provisionable by Vendor
        • Get details of Specific Model
        • Get list of Provisionable Server Profiles
        • Read Provisionable Server Details
      • Read Mac Addresses
      • Add MAC address
      • Update MAC address
      • Remove MAC address
      • Count Mac Addresses
      • Read Mac Addresses in Domain
      • Add MAC address for Domain
      • Update MAC address in Domain
      • Remove MAC address in Domain
      • Read Specific Mac Address
      • Read Specific Mac Addresses in Domain
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Create Site in Domain
    • Count Sites in Domain
    • Update Site in Domain
    • Read Specific Site in Domain
  • Call Center
    • Callqueues
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
      • Read Basic info on Call Queues in Domain
    • Agents
      • Read Agents in Call Queue
      • Add Agent to Call Queue
      • Count Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
      • Add a Queued Call
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
      • Get DNIS Statistics for all Queues
      • Get DNIS Statistics for Single Queue
      • Get Agent Log
      • Get Abandoned Calls for all Queues
      • Get Abandoned Calls for a Specific Queue
  • Email
    • Send Email using Template
    • Verify Email
  • Answer Rules
    • Read Answerrules for a User
    • Add a Answerrule for a User
    • Count Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Delete a Answerrule for a User
    • Update a Answerrule for a User
    • Reorder Answerrules for my User
  • Call Blocking
    • Read blocked numbers for a Domain
    • Add blocked numbers for a Domain
    • Delete blocked numbers for a Domain
    • Read blocked numbers for a User
    • Add blocked numbers for a User
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
    • Delete Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Count Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Delete Voicemail
      • Move Voicemail to save folder
      • Forward Voicemail to another user
    • Greetings
      • Read Greetings for User
      • Create a new Greeting from TTS
      • Count Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Create a new MOH for Domain from TTS
        • Count MOH for Domain
        • Update MOH for Domain from TTS
        • Delete MOH for Domain
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
      • User
        • Read MOH for User
        • Create a new MOH for Domain from TTS
        • Count MOH for User
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Delete MOH for User
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Count Hold Messages for Domain
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Count Hold Messages for User
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • CDR (Call History)
    • Read CDRs
    • Read CDRs for Domain
    • Read CDRs for Specific User
    • Search CDRs for Domain
    • Read CDRs for Site in Domain
    • Count CDRs and SUM minutes
    • Count CDRs and SUM minutes for Domain
    • Count CDRs and SUM minutes for Specifc User
  • CDR Schedule
    • Count CDR Schedules for Domain
    • Count CDR Schedules for Reseller
    • Count CDR Schedules by Name
  • Call Traces & Cradle to Grave
    • Get Call Trace (SIPFlow) For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Calls (live
    • active calls)
      • Read Active Calls In Domain
      • Count Active Calls In Domain
      • Read Active Calls for User
      • Make a new Call
      • Read Specific Active Call
      • Disconnect Call
      • Transfer Peer Call
      • Transfer Call
      • Answer Call
      • Hold Active Call
      • Un-Hold Active Call
      • Reject Call
      • Report Active Calls
  • Contacts
    • Shared Contacts
      • Get Domain Contacts
      • Create Shared Contact
      • Get Specific Domain Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get Contacts for User
    • Create Contact
    • Get Specific Contact for User
    • Update Contact
    • Delete Contact
    • Count Contacts for User
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Create Address for Domain
    • Validate Address
    • Update Address for Domain
    • Delete Address For Domain
    • Update Address for User
    • Get Address Using Address ID
    • Update Address Endpoint
    • Delete Address Endpoint
    • Create Address for User
    • Get Addresses for User
    • Delete Address For User
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
    • Count Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Add a new dial rule into a dial plan
    • Count Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
    • Read Dialplans
    • Create Dialplan Global
    • Create Dialplan for Domain
    • Update Dialplan for Domain
    • Delete Dialplan for Domain
  • Dial Permisions
    • Read Policies
    • Create Dialpolicy Table
    • Read Specific Policy
    • Update Dialpolicy
    • Delete Dialpolicy
    • Read Specific Policy in Domain
    • Update Dialpolicy in Domain
    • Delete Dialpolicy in Domain
    • Read Permissions in a DialPolicy
    • Add a new permission to a dialpolicy table
    • Read Permissions in a DialPolicy in Domain
    • Add a new permission to a dialpolicy table in Domain
    • Read Specific Permission in a Dialpolicy
    • Update a permission in a dialpolicy table
    • Delete a permission by ID in a dialpolicy
    • Read Specific Permission in a Dialpolicy in Domain
    • Update a permission in a dialpolicy table in Domain
    • Delete a permission by ID in a dialpolicy in Domain
  • Messages
    • SMS Block
      • Read SMS Blocks for Domain
      • Add SMS Blocks for Domain
      • Read SMS Blocks for all Domains
      • Update SMS Block for Domain
      • Delete/Deactivate SMS Block for Domain
    • Get Messagesessions for Domain
    • Start a new Message Session
    • Get Messagesessions for User
    • Get Messagesession for User
    • Update Messagesession (Participants)
    • Delete Messagesession
    • Get Messages for Messagesession
    • Send a message (Chat)
    • Send a message (Group Chat)
    • Send a message (Media Chat)
    • Send a message (SMS)
    • Send a message (Group SMS)
    • Send a message (MMS)
    • Update Messagesession (Session Name)
    • Update Messagesession (Leave)
  • SMS Numbers
    • Get SMS Numbers for Domain
    • Create SMS Number
    • Get All SMS Numbers for System
    • Update SMS Number
    • Delete an SMS Number
    • Get SMS Numbers for User
    • Count SMS Numbers for User
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
  • Connections
    • Get All Connections
    • Create a Connection
    • Count All Conections
    • Get All Connections for a Domain
    • Get Specific Connection for a Domain
    • Delete a Specific Connection for a Domain
    • Update a Connection
  • Routes
    • Read Routes
    • Create a Route
    • Count All Routes
    • Read Route Connections for Route
    • Create a Route Connection
    • Count All Route Connections
    • Update A Specific Route
    • Delete A Specific Route
    • Update A Specific Route Connection
    • Delete A Specific Route connection
  • Meetings
    • Event Logs
      • Create a Meeting Log Event
      • Read Meeting Events
    • Iotum
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Create a Ad-hoc Conference
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Update Domain's Iotum Company
      • Create Iotum Video Company
      • Delete a Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Update User's Iotum Host
      • Delete a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Delete Iotum Video Subscription
      • Update Domain's Iotum Subscriptions
    • Create a Meeting with Id
    • Read Meeting
    • Create a Meeting
    • Read Meetings for User
    • Count Domains Meetings
    • Count Meeting
    • Register Meeting
    • Update a Meeting
    • Delete a Meeting
    • Request a Meeting ID
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • Read a Specific Configuration
      • Delete a Configuration
      • Read all Configurations
      • Create a Configuration
      • Update a Configuration
      • Count Configurations
    • Configuration Definitions
      • Read all Configuration Definitions
      • Create a Configuration Definition
      • Read a Specific Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Update Template from Upload (JSON + Base64 File)
  • Timeframes
    • Domain (Shared)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
      • Holiday
        • Create Additional Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Holidays Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Custom
        • Create Additional Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
      • Holiday
        • Create Additional Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Holidays Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Custom
        • Create Additional Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe for User
      • Delete All Timeframes for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • Read SSL certificates for CertManager
    • Create SSL certificate for CertManager
    • Read SSL certificate by Common Name
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  • iNSight
    • Query Data from iNSight
  • Conference
    • Conferences
      • Get Conferences in Domain
      • Create Conference for Domain
      • Get Conference in Domain
      • Update Conference in Domain
      • Delete Conference in Domain
      • Count Conferences in Domain
      • Get Conference CDR from Domain
    • Participants
      • Get Participants from Conference
      • Create Participant for Conference
      • Update Participant for Conference
      • Delete Participant from Conference
  • SnapBuilder
    • Phone Templates
      • Read Phone Templates available to a Domain
      • Create Phone Template in domain
      • Read Specific Phone Templates by name
      • Update Phone Template in domain
      • Delete Phone Template in domain
      • Count Phone Templates for a Domain
    • Read Device Profiles
    • Count Device Profiles
    • Get specific Device Profile for Model of Phone
    • Count Phone Configurations in a Domain
    • Get Phone Configuration for specific Mac
    • Update Phone Configuration for Specific Mac Address
    • Delete Phone Configuration for Specific Mac Address
    • Create Phone Configuration for Specific Mac Address
  • Charts
    • Count Charts
    • Get Chart List
  • Dashboards
    • Count Dashboards for a User
    • Get Dashboard List for a User
  • Quotas
    • Get Quota for Domain
    • Get Quota for Domains in Reseller
    • Count Quotas for Domain
    • Count Quotas for Reseller
  • Departments
    • List Departments in a Domain
  • Presence
    • List Presence in a Domain
    • List Presence in a Department
  • Audit Log
    • Read Audit Log
  • Access Log
    • Read Accesslog
  • Schemas
    • Enums
      • YesNoString
      • YesNoStringYesDefault
      • YesNoStringNoDefault
      • StringDefaultStar
      • DomainName
      • DomainNamePath
      • UserName
      • UserNamePath
      • SuccessResponse
      • ErrorResponse
      • Count
      • TimeZone
      • Scopes
      • SubscriptionModel
      • Synchronous
      • DialruleApplication
      • CallqueuePath
      • AgentPath
      • AutoAttendantFailOptions
      • Timestamp
      • DeleteType
      • OneZeroBoolean
      • OneZeroDefaultOne
      • OneZeroDefaultZero
      • MeetingStatus
      • RecordingConfiguration
      • MessageType
      • MimeTypes
      • StringInteger
      • DatetimeStart
      • DatetimeEnd
      • RecurringTimeframeType
      • RecurringTimeframeHolidayObservance
      • Limit
      • Start
      • Permission
      • Dialpolicy
    • securitySchemes
      • ApiKeyAuth
    • Default Folder
      • Certficate
      • DeviceProfileButton
      • DeviceProfile
      • DeviceImage
      • DeviceModelButtonType
      • InsightValue
      • PhoneConfigBtn
      • SmsBlock
    • Domain
    • DomainLegacy
    • User
    • UserLegacy
    • Device
    • CallQueue
    • Agent
    • Answerrule
    • AnswerruleFeature
    • AnswerruleFeatureWithRemove
    • AnswerruleFeatureSimRing
    • AnswerruleLegacy
    • Site
    • AuthRequest
    • AuthRequestMFA
    • SSOEnroll
    • CallRequest
    • ActiveCall
    • DialRule
    • Phonenumber
    • Contact
    • Timeframe
    • Timerange
    • AccessToken
    • Address
    • AddressCreateReturn
    • AddressEndpoint
    • AddressValidate
    • Reseller
    • ApiKey
    • Audiofile
    • MediaRequest
    • CdrD
    • CdrU
    • CdrR
    • NdpPhone
    • NdpModel
    • NdpServer
    • Messagesession
    • Message
    • MessageSend
    • SmsNumber
    • Vmailnag
    • DomainBilling
    • Subscription
    • Recording
    • EmailCreate
    • Agentlog
    • DeviceLegacy
    • CallActions
    • TtsVoice
    • AutoAttendant
    • AutoAttendantTier
    • AutoAttendantTierOption
    • Restore
    • BackupResponse
    • Meeting
    • Configuration
    • ConfigDefinition
    • ConnectionExtra
    • Connection
    • DeletegateRequest
    • JwtResponse
    • JwtRequestSuccess
    • Image
    • Template
    • RecurringTimeframe
    • TimeframeSpecificDate
    • TimeframeHoliday
    • TimeframeDOW
    • IotumHost
    • IotumContact
    • RecordingOld
    • CallBlocking
    • Transcription
    • NumberEnabledMap
    • Dialplan
    • Conference
    • ConferenceParticipant
    • ConferenceCDR
    • Chart
    • Dashboard
    • Presence
    • Route
    • RouteConnection
    • PublicUserInfo
    • DispositionReason
    • DeviceModel
    • Holiday
    • Auditlog
    • QueueStat
    • Phoneconfiguration
    • AbandondedCallStat
    • OIDCProvider
  1. API Key (Machine 2 Machine)

Read API Key info on your API Key

NMS-Prod API v2
https://api.trueipsolutions.com/ns-api/v2
NMS-Prod API v2
https://api.trueipsolutions.com/ns-api/v2
GET
https://api.trueipsolutions.com/ns-api/v2
/apikeys/~
This parameter-less action will return the information on the API key being used for the request giving confirmation on access levels allowed.

Request

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

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.trueipsolutions.com/ns-api/v2/apikeys/~' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK
application/json
Bodyapplication/json

Example
{
    "description": "Used by Vendor Xyz for Billing Automation",
    "key-id": "nsd-123dsa23",
    "key": "string",
    "reseller": "*",
    "user": "1000",
    "domain": "example.com",
    "user-scope": "Basic User",
    "ip-address": "1.2.3.4,5.6.7.0/24",
    "readonly": "no",
    "can-create-keys": "no",
    "allowed-models": "string",
    "created-datetime": "2019-08-24T14:15:22.123Z",
    "lastused-datetime": "2019-08-24T14:15:22.123Z"
}
Modified at 2026-02-09 21:10:48
Previous
SSO Enroll
Next
Read API Keys under your account
Built with