Add a Answerrule for a User

Time	Status	User Agent
Retrieving recent requests…

Path Params

domain

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.

user

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.

Body Params

synchronous

string

enum

required

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:

time-frame

string

required

This is the timeframe that also is needed to make this set of answer rules unique. * is teh default and if no timeframes are setup this is is how to set anserrules.

enabled

string

enum

required

Defaults to yes

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

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

This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.

new-position

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

This is a list of numbers that would be allowed bypassing features like do-not-disturb and call-screening.

202

400

401

404