API Reference
Start typing to search…

Create User in Domain

post
https://{server}/ns-api/v2/domains//users
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

This is the main user extension for the user account.

string
required

This is the first name for the user

string
required

This is the last name for the user

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
required

This is the email adresses or list of email addresses sepertaed with a semi-colon.

string
enum
required
Defaults to Basic User

This is the scope that should be enforced in combination with the reseller, domain and user fields. it will be set using the scope used to create the subscription.

string

This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user.

string

This is the site or location for this user. The site will group users that are at the same phyiscal location, but can be used for other grouping purposes as well. New users will inherit some settings from the site if the site was previously setup. If the site is not previously created then a new site will be created with the value given on new user create assuming the domain's max sites setting has remaining sites.

string
enum

The timezone which the meeting was created with

integer

This is the numberic pin that would be used by the user validating their account when connecting into voice IVR to check voicemail.

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
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

This is is a value that is often set by the end user to show their current status, often a away message of some kind.

integer
100 to 999

This is a 3 digit numberic mapping that correlates to the first 3 digits of a user's first or last name for dial by name directory. Example Smith would be "764" translating the letters to numbers using the normal phone number mappings.

string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
integer
0 to 3600

This time setting in seconds will controll how long a inbound call attempt will attempt to connect the call before stopping and attempting the next option which might be a forward setting in answer rules or voicemail if enabled.

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

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
integer
0 to 100

This value can be used in cases where multiple users have the same value for directory-name-number-dtmf-mapping, if they are the same then use this setting to set the order low to high for playback in dial by name directory menu.

integer
≥ 0

This is the index of the greeting that is enabled currently for the user. Greeting 0 is the generic "[name] is not available" message will be played.

string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to yes

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string

This list of user's which will be forward copies of new voicemails left on that user.

string
enum
Defaults to no

This is the behavior that the voicemail logic will take after a voicmail is left. The options include ability to send with attachements or hyperlinks.

string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
integer
≥ 10

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.

integer
≥ 10

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

This allows any added configurations to specify a hostname. Default to "yes"

Allowed:
string

Service codes are for internal use that allow user's to be tagged for billing and tracking purposes. Any service code starting with "system-" will be hidden by default in the portals and not count as regular users.

string
enum
Defaults to no

Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded.

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 will enable IP checking. Default is no

Allowed:
string
enum
Defaults to no

This will enable IP checking. Default is no

Allowed:
integer
0 to 3600

This interval will control how frequently the music on hold would be interupted and have messages played. Should be used when using music on hod and custom messages.

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:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*
Updated 11 months ago