API Reference
Start typing to search…

Update a Answerrule for a User

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

string
required
length between 0 and 16
Defaults to ~

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

string
required
Body Params
string
enum
required
Defaults to yes

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

Allowed:
simultaneous-ring
object

This is a feature that will allow multiple phones or remote extensions to be called at the same time.

do-not-disturb
object

When enabled this feature will block all inbound ringing and send the call to voicemails if enabled.

forward-always
object
forward-on-active
object
forward-on-busy
object
forward-no-answer
object
forward-when-unregistered
object
forward-on-dnd
object
forward-on-spam-call
object
call-screening
object

When enabled this feature will enable the call screening application asking the caller to record their name before attempting the connection based on other answer rules.

phone-numbers-to-allow
object
string
enum

This will move the answerrule to the top or bottom in the priority list. Top having the most priority, and bottom having the least priority

Allowed:
phone-numbers-to-reject
object
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