- Version
- Authentication
- Access Token (Oauth - Username
- API Key (Machine 2 Machine)
- JWT (JSON Web Token)
- Event Subscriptions
- Read Event SubscriptionsGET
- Create a Event SubscriptionPOST
- Read Event Subscriptions for DomainGET
- Create a Event Subscription for DomainPOST
- Read Event Subscription By IdGET
- Update an Event SubscriptionPUT
- Delete a subscriptionDELETE
- Update an Event Subscription for DomainPUT
- Delete a subscription For DomainDELETE
- Read Event Subscriptions
- Resellers
- Domains
- Phone Numbers
- Use Cases
- Get All Phone Numbers for DomainGET
- Add Phone Number in DomainPOST
- Count Phone Numbers for DomainGET
- Get All Phone Numbers for System or ResellerGET
- Count All Phone Numbers for System or ResellerGET
- Remove Phone Number from DomainDELETE
- Update Phone Number in DomainPUT
- Get Specific Phone Number in DomainGET
- Users
- Devices
- Phones
- Sites
- Call Center
- Callqueues
- Agents
- Agent Actions
- QueuedCalls
- 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
- Answer Rules
- Call Blocking
- Auto Attendant
- Media
- Voicemail
- 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)
- Domain
- Hold Messages
- Text to Speech
- CDR (Call History)
- CDR Schedule
- Call Traces & Cradle to Grave
- Transcriptions & Sentiment
- Calls (live
- 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
- 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
- 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
- Recordings
- Connections
- Routes
- Meetings
- Event Logs
- 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
- Configs
- Images
- Templates
- Timeframes
- Domain (Shared)
- User
- Holiday Information
- Firebase
- SSL Certificates
- iNSight
- Conference
- SnapBuilder
- Phone Templates
- 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
- Dashboards
- Quotas
- Departments
- Presence
- Audit Log
- Access Log
- 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
- Default Folder
- 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
- Enums
Add Phone Number in Domain
NMS-Prod API v2
https://api.trueipsolutions.com/ns-api/v2
NMS-Prod API v2
https://api.trueipsolutions.com/ns-api/v2
POST
https://api.trueipsolutions.com/ns-api/v2
Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Path Params
Body Params application/json
Example
{
"phonenumber": "{{demo_phonenumber}}",
"enabled": "yes",
"dial-rule-matching-start-date": "*",
"dial-rule-matching-end-date": "*",
"dial-rule-application": "available-number",
"dial-rule-translation-destination-user": "[*]",
"dial-rule-translation-destination-host": "[*]",
"dial-rule-translation-source-name": "[*]",
"dial-rule-description": "Test Number"
}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 --globoff 'https://api.trueipsolutions.com/ns-api/v2/domains/{{domain}}/phonenumbers' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"phonenumber": "{{demo_phonenumber}}",
"enabled": "yes",
"dial-rule-matching-start-date": "*",
"dial-rule-matching-end-date": "*",
"dial-rule-application": "available-number",
"dial-rule-translation-destination-user": "[*]",
"dial-rule-translation-destination-host": "[*]",
"dial-rule-translation-source-name": "[*]",
"dial-rule-description": "Test Number"
}'Responses
🟢202Accepted
application/json
Bodyapplication/json
Example
{
"code": 0,
"message": "string"
}🟠409Duplicate
Modified at 2026-02-09 21:10:48