API Reference

Create Site in Domain

post
https://{server}/ns-api/v2/domains//sites
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 64
Defaults to ~

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Body Params
string
enum
Defaults to no

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:
string
required
string

This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique.

string
enum

This is the time zone that the user is primarily located in

string

This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user.

string

This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level.

string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
Defaults to en_US

This is the language that is set for the user to be used for portal viewing.

integer
≥ 0

This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage.

integer
0 to 3600

This is the maximum number of active calls allowed for the user.

string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string
enum
Defaults to no

This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.

Allowed:
string
enum
Defaults to no

This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.

Allowed:
string
enum
Defaults to no

This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.

Allowed:
string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string

This is the main caller id number for the user to be used for outbound calls outside of the domain.

string

This is the main caller id name for the user to be used for outbound calls outside of the domain.

This is the main caller id that will be used for emergency calls when placed by the user.

integer
100 to 999

This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number.

string
enum
Defaults to yes

When enabled this setting will turn on voicemail for the user.

Allowed:
string

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

string
enum
Defaults to no

This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.

Allowed:
string
enum
Defaults to no

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago