NetSapiens API v2
  1. Domains
NetSapiens API v2
  • TODO LIST
  • Version
    • Read API Version
      GET
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Key info on your API Key
      • Read API Keys under your account
      • Read Info on specific APIKey via Key ID
      • Create API Key
      • Update API Key
      • Revoke API Key
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • 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)
      • Revoke current JWT
      • Read Current JWT
  • Event Subscriptions
    • Read Event Subscriptions
      GET
    • Read Event Subscription By Id
      GET
    • Create a Event Subscription
      POST
    • Update an Event Subscription
      PUT
    • Delete a subscription
      DELETE
  • Resellers
    • Get Resellers
      GET
    • Create Reseller
      POST
    • Update Reseller
      PUT
    • Delete Reseller
      DELETE
    • Get Specific Reseller
      GET
  • Domains
    • Get Domains
      GET
    • Count Domains
      GET
    • Get Specific Domain
      GET
    • Get Specific Domain With Billing Summary
      GET
    • Get My Domain Info
      GET
    • Check if Domain Exists
      GET
    • Create a Domain
      POST
    • Update a Domain
      PUT
    • Delete a Domain
      DELETE
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
    • Get All Phone Numbers for System or Reseller
    • Get All Phone Numbers for Domain
    • Add Phone Number in Domain
    • Remove Phone Number from Domain
    • Update Phone Number in Domain
    • Get Specific Phone Number in Domain
  • Users
    • Get Users in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Create User in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
  • Devices
    • Count Devices for User
    • Get Devices for User
    • Create Device for User
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
  • 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
    • Read Mac Addresses in Domain
    • Read Specific Mac Address
    • Add MAC address
    • Add MAC address for Domain
    • Update MAC address
    • Update MAC address in Domain
    • Remove MAC address
    • Remove MAC address in Domain
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Create Site 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
    • Agents
      • Read Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to 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
    • 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
  • Answer Rules
    • Read Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Add a Answerrule for a 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
    • Read blocked numbers for a User
    • Add blocked numbers for a Domain
    • Add blocked numbers for a User
    • Delete blocked numbers for a Domain
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • 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
        • Update MOH for Domain from TTS
        • 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)
        • Delete MOH for Domain
      • User
        • Read MOH for User
        • Create a new MOH for Domain from TTS
        • 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
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Delete MOH for User
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • 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)
        • 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
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • 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
  • Calls (live/active calls)
    • Read Active Calls In Domain
    • Count Active Calls In Domain
    • Read Active Calls for User
    • Read Specific Actice Call
    • Make a new 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
      • Get Specific Domain Contact
      • Create Shared Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get Contacts for User
    • Get Specific Contact for User
    • Count Contacts for User
    • Create Contact
    • Update Contact
    • Delete Contact
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Validate Address
    • Create Address for Domain
    • Update Address for Domain
    • Update Address for User
    • Update Address Endpoint
    • Create Address for User
    • Delete Address For User
    • Delete Address Endpoint
    • Delete Address For Domain
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
    • Get Addresses for User
    • Get Address Using Address ID
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Add a new dial rule into a dial plan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
  • Messages
    • Get Messagesessions for Domain
    • Start a new Message Session
    • Get Messagesessions for User
    • 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 (Participants)
    • Update Messagesession (Session Name)
    • Update Messagesession (Leave)
    • Delete Messagesession
  • SMS Numbers
    • Get All SMS Numbers for System
    • Get SMS Numbers for Domain
    • Create SMS Number
    • Update SMS Number Copy
    • 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
  • Email
    • Send Email using Template
  • Connections
    • Get All Connections
    • Count All Conections
    • Get All Connections for a Domain
    • Get Specific Connection for a Domain
    • Delete a Specific Connection for a Domain
    • Create a Connection
    • Update a Connection
  • Routes
    • Read Routes
    • Count All Routes
    • Read Route Connections
    • Count All Route Connections
    • Create a Route
    • Create a Route Connection
    • Delete A Specific Route
    • Update A Specific Route
    • Update 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
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • Create a Meeting with Id
    • Create a Meeting
    • Read Meeting
    • Count Domains Meetings
    • Count Meeting
    • Register Meeting
    • Update a Meeting
    • Delete a Meeting
    • Request a Meeting ID
    • Read Meetings for User
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Read a Specific Configuration Definition
      • Create a Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (Multipart/Mixed Post)
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Update Template from Upload (Multipart/Mixed Post)
    • 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
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry 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
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Delete Entry within Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe 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
    • Read SSL certificate by Common Name
    • Create SSL certificate for CertManager
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  1. Domains

Create a Domain

POST
/domains
Last modified:2023-12-21 20:51:58
OperationId:CreateDomain
This API will allow a new domain to be created. Version 2 of the api will assist in creating some resources that previously were not auto created on api domain create inlcuding creating a "domain" subscriber for the owner to hold the defaults and creating a dialplan with a name that matches the domain that is chained up to a system wide table.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
synchronous
enum<string> 
write-onlyoptional
When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.
Allowed values:
yesno
Default:
no
domain
string 
required
This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).
<= 64 characters
Examples:
example.commyDomaintest.12123
Match pattern:
^[A-Za-z0-9._-]+|\*
reseller
string 
required
This is the reseller that owns this domain. Must be a valid resller name on creation. If Reseller level scope you can use "~" to set your own reseller on create, Super User's will need to set this to a valid Reseller.
description
string 
optional
This is a description of the domain. This will be shown in many places to help show a more user friendly version of the domain to help identify it.
music-on-hold-enabled
enum<string> 
optional
Enabled will trigger music on hold for the domain and allow it to be customized.
Allowed values:
yesno
music-on-ring-enabled
enum<string> 
optional
Enabled will trigger music on ringing applications in certain call flows only.
Allowed values:
yesno
music-on-hold-randomized-enabled
enum<string> 
optional
Enabled will allow the MOH (music on hold) to be reandomized and not always play the caller the sames file to start
Allowed values:
yesno
domain-type
enum<string> 
optional
Allows a special domain type to be set for specific use cases. Currently Residenital and Hospitality are options which will limit and effect the users expierence.
Allowed values:
StandardResidentialHospitality
dial-plan
string 
optional
This is the default dial plan that will be used for new users created in the domain. A dial plan is created by default on new domain creation with a name matching the domain.
dial-policy
string 
optional
This is the default dial policy (permission) that will be used for new users added ot the domain. Generally these are system wide policies and will not need to create one per domain.
email-send-from-address
string 
optional
This is the email source that will be used when sending out emails for this domain. This address should be configured properly through the email server so that emails are not blocked. In most cases this is recommended to be an address on the service providers or resellers hostname so DNS SPF records can be added on the hostname to prevent spam issues. More info on SPF records available via https://www.cloudflare.com/learning/dns/dns-records/dns-spf-record/
single-sign-on-enabled
enum<string> 
optional
When enabled it will allow users in the domain to sign in and authenticate using 3rd pary SSO (single sign on) allplications such as google, Microsoft and Apple
Allowed values:
yesno
area-code
number 
optional
The default area code for the domain. This is used by default on 7 digit dials to extent the number to a valid 10 digit number.
>= 100<= 999
Example:
858
caller-id-name
string 
optional
This is the main caller id name for the user to be used for outbound calls outside of the domain.
caller-id-number
number 
optional
This is the main caller id number for the user to be used for outbound calls outside of the domain.
Example:
18005551234
caller-id-number-emergency
number 
optional
This is the main caller id that will be used for emergency calls when placed by the user.
Example:
18005551234
limits-max-subcriber-resources-total
integer 
optional
This is the maximum number of subscribers allowed for domain including the subscribers that would be created as part of resources like call queues and auto attendants. If looking to limit nornal users it would be better to use limits-max-users
limits-max-active-calls-total
integer 
optional
This is the limit for the number of active calls allowed in the domain simultaniously. Note: this will count and limit intra domain calls.
limits-max-active-calls-offnet
integer 
optional
This is the limit for the number of active calls allowed in the domain simultaniously that are connected to offnet or external numbers.
limits-max-call-queues
integer 
optional
This is the maximum number of call queues that would be allowed to be created in this domain.
limits-max-auto-attendants
integer 
optional
This is the maximum number of auto attendants that would be allowed to be created in this domain.
limits-max-conferences
integer 
optional
This is the maximum number of conference bridges that would be allowed to be created in this domain.
limits-max-departments
integer 
optional
This is the maximum number of departments that would be allowed to be created in this domain.
limits-max-users
integer 
optional
This is the maximum number of regular users that would be allowed to be created in this domain.
limits-max-sites
integer 
optional
This is the maximum number of sites that would be allowed to be created in this domain.
limits-max-fax-accounts
integer 
optional
This is the maximum number of fax accounts that would be allowed to be created in this domain.
time-zone
enum<string> 
optional
This is the time zone that the user is primarily located in
Allowed values:
US/AlaskaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificAfrica/Addis_AbabaAfrica/AlgiersAfrica/BrazzavilleAfrica/CairoAfrica/CasablancaAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/JohannesburgAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/NairobiAfrica/TimbuktuAfrica/TripoliAfrica/TunisAmerica/AntiguaAmerica/ArubaAmerica/BelizeAmerica/BogotaAmerica/Buenos_AiresAmerica/CancunAmerica/CaracasAmerica/CaymanAmerica/ChihuahuaAmerica/Costa_RicaAmerica/DenverAmerica/DetroitAmerica/EdmontonAmerica/El_SalvadorAmerica/EnsenadaAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/HavanaAmerica/IndianapolisAmerica/JamaicaAmerica/JuneauAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/LouisvilleAmerica/MartiniqueAmerica/MazatlanAmerica/MendozaAmerica/MenomineeAmerica/MeridaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontrealAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/PanamaAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/ReginaAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ThuleAmerica/Thunder_BayAmerica/TijuanaAmerica/TorontoAmerica/VancouverAmerica/WinnipegAmerica/YellowknifeAntarctica/South_PoleArctic/LongyearbyenAsia/AmmanAsia/BaghdadAsia/BahrainAsia/BangkokAsia/BeirutAsia/BruneiAsia/CalcuttaAsia/ColomboAsia/DaccaAsia/DamascusAsia/DhakaAsia/DubaiAsia/GazaAsia/Hong_KongAsia/IstanbulAsia/JakartaAsia/JerusalemAsia/KabulAsia/KatmanduAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/ManilaAsia/MuscatAsia/Phnom_PenhAsia/RangoonAsia/RiyadhAsia/SaigonAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/TaipeiAsia/TehranAsia/Tel_AvivAsia/ThimphuAsia/TokyoAsia/Ulan_BatorAsia/VientianeAsia/VladivostokAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaeroeAtlantic/ReykjavikAustralia/ACTAustralia/AdelaideAustralia/BrisbaneAustralia/CanberraAustralia/DarwinAustralia/LHIAustralia/MelbourneAustralia/NorthAustralia/NSWAustralia/PerthAustralia/QueenslandAustralia/SouthAustralia/SydneyAustralia/TasmaniaAustralia/VictoriaAustralia/WestCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificCanada/SaskatchewanCanada/YukonCubaEtc/GMTEtc/GMT+1Etc/GMT+10Etc/GMT+11Etc/GMT+12Etc/GMT+2Etc/GMT+3Etc/GMT+4Etc/GMT+5Etc/GMT+6Etc/GMT+7Etc/GMT+8Etc/GMT+9Etc/GMT-1Etc/GMT-10Etc/GMT-11Etc/GMT-12Etc/GMT-13Etc/GMT-14Etc/GMT-2Etc/GMT-3Etc/GMT-4Etc/GMT-5Etc/GMT-6Etc/GMT-7Etc/GMT-8Etc/GMT-9Etc/GreenwichEurope/AmsterdamEurope/AthensEurope/BelfastEurope/BelgradeEurope/BerlinEurope/BrusselsEurope/BucharestEurope/BudapestEurope/CopenhagenEurope/DublinEurope/HelsinkiEurope/IstanbulEurope/KievEurope/LisbonEurope/LjubljanaEurope/LondonEurope/MadridEurope/MaltaEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PragueEurope/RomeEurope/SofiaEurope/StockholmEurope/ViennaEurope/WarsawEurope/ZurichGreenwichPacific/AucklandPacific/EasterPacific/FijiPacific/GalapagosPacific/GambierPacific/GuamPacific/HonoluluPacific/MarquesasPacific/MidwayPacific/PalauPacific/RarotongaPacific/Tahiti
email-send-smtp-hostname
string <hostname> | null 
optional
This is the SMTP server hostname. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.
email-send-smtp-port
string  | null 
optional
This is the SMTP port for sending emails. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.
email-send-smtp-username
string  | null 
optional
This is the username used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.
email-send-smtp-password
string <pass> | null 
optional
This is the password used in connecting to SMTP server for sending email. SMTP server configs are NOT required at domain level as they will inherit reseller or system level as needed.
emergency-address-id
string  | null 
optional
Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling
voicemail-enabled
enum<string> 
optional
This setting will control whether voicemail is enabled for the user account. Generally only controllable via the admins and not the user itself.
Allowed values:
yesno
recording-configuration
enum<string> 
optional
Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"
Allowed values:
yesyes-with-transcriptionyes-with-transcription-and-sentimentno
Default:
no
voicemail-transcription-enabled
enum<string> 
optional
Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded.
Allowed values:
noDeepgramGoogleMutareVoicebase
Default:
no
language-token
string 
optional
This is the language that is set for the user to be used for portal viewing.
Default:
en_US
Examples:
es_MXen_CA
is-domain-locked
enum<string> 
optional
If set this will "lock" a domain preventing any non emergency calls from completing. Often used before turnup or in a lack of payment situation
Allowed values:
yesno
is-stir-enabled
enum<string> 
optional
If enabled STIR actions will be enabled for this domain including ability to validate an STIP/SHAKEN identities
Allowed values:
yesno
is-ivr-forward-change-blocked
enum<string> 
optional
When enabled this setting will block forwards from being set/modifed via the voicemail IVR.
Allowed values:
yesno
Example
{
  "synchronous": "no",
  "domain": "{{domain}}",
  "reseller": "{{reseller}}",
  "description": "This is a example  in reseller {{reseller}}.",
  "time-zone": "US/Pacific",
  "language": "en_US",
  "single-sign-on-enabled": "yes",
  "area-code": "858",
  "caller-id-name": "{% faker company.name %}",
  "caller-id-number": "{% faker datatype.number %}{% faker datatype.number %}",
  "caller-id-number-emergency": "{% faker datatype.number %}{% faker datatype.number %}",
  "dial-policy": "US and Canada",
  "music-on-hold-enabled": "yes",
  "music-on-hold-randomized-enabled": "yes"
}

Request 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 --request POST 'https://awqacore01.crexendocloud.com/ns-api/v2/domains' \
--header 'Content-Type: application/json' \
--data-raw '{
    "synchronous": "no",
    "domain": "{{domain}}",
    "reseller": "{{reseller}}",
    "description": "This is a example  in reseller {{reseller}}.",
    "time-zone": "US/Pacific",
    "language": "en_US",
    "single-sign-on-enabled": "yes",
    "area-code": "858",
    "caller-id-name": "{% faker company.name %}",
    "caller-id-number": "{% faker datatype.number %}{% faker datatype.number %}",
    "caller-id-number-emergency": "{% faker datatype.number %}{% faker datatype.number %}",
    "dial-policy": "US and Canada",
    "music-on-hold-enabled": "yes",
    "music-on-hold-randomized-enabled": "yes"
}'

Responses

🟢202Accepted
application/json
Body
code
integer 
required
message
string 
required
Example
{
  "code": 0,
  "message": "string"
}
🟠409Domain Already Exists
🟢200OK
🟠404Record not found
🟠400Bad Request
🟠401Authentication Required
Modified at 2023-12-21 20:51:58
Previous
Check if Domain Exists
Next
Update a Domain
Built with