Create a Domain

post

https://{server}/ns-api/v2/domains

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

synchronous

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:

domain

string

required

length ≤ 64

This is the domain that the token will be limited to.

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

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

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

music-on-ring-enabled

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

music-on-hold-randomized-enabled

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

domain-type

string

enum

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:

dial-plan

string

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

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

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

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

area-code

number

100 to 999

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.

caller-id-name

string

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

caller-id-number

number

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

caller-id-number-emergency

number

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

limits-max-subcriber-resources-total

integer

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

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

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

This is the maximum number of call queues that would be allowed to be created in this domain.

limits-max-auto-attendants

integer

This is the maximum number of auto attendants that would be allowed to be created in this domain.

limits-max-conferences

integer

This is the maximum number of conference bridges that would be allowed to be created in this domain.

limits-max-departments

integer

This is the maximum number of departments that would be allowed to be created in this domain.

limits-max-users

integer

This is the maximum number of regular users that would be allowed to be created in this domain.

limits-max-sites

integer

This is the maximum number of sites that would be allowed to be created in this domain.

limits-max-fax-accounts

integer

This is the maximum number of fax accounts that would be allowed to be created in this domain.

time-zone

string

enum

The timezone which the meeting was created with

email-send-smtp-hostname

string | null

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

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

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 | null

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

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

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

recording-configuration

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:

voicemail-transcription-enabled

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:

language-token

string

Defaults to en_US

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

is-domain-locked

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

is-stir-enabled

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

is-ivr-forward-change-blocked

string

enum

Enabled will trigger music on hold for the domain and allow it to be customized.

Allowed:

Responses

200OK

202Accepted

400Bad Request

401Authentication Required

404Record not found

409Domain Already Exists