Add a Answerrule for a User

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

domain

string

required

Example:

user

string

required

Example:

Body Params application/json

synchronous

enum<string>

write-onlyrequired

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

yesno

Default:

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

enum<string>

required

When enabled this rule is available to be user though it may not be active as the timeframe might not match the current time or there could be other hihger priority timeframes.

Allowed values:

yesno

Default:

yes

simultaneous-ring

object

optional

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

enabled

enum<string>

required

This settings will control if the the parent feature is enabled.

Allowed values:

yesno

Default:

parameters

array [anyOf]

optional

This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.

do-not-disturb

object

optional

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

enabled

enum<string>

required

This settings will control if the the parent feature is enabled.

Allowed values:

yesno

Default:

forward-always

object (AnswerruleFeature)

optional

This feature will allow a call to be moved to a new forward destination.

enabled

enum<string>

required

This settings will control if the the parent feature is enabled.

Allowed values:

yesno

Default:

parameters

array [anyOf]

optional

This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.

forward-on-active

object (AnswerruleFeature)

optional

This feature will allow a forwarding the call when the user is active (having at least 1 call active).

forward-on-busy

object (AnswerruleFeature)

optional

This feature will allow forwarding the call when the system is returning busy and unable to take new calls.

forward-no-answer

object (AnswerruleFeature)

optional

This feature will allow forwarding the call when the system has rung devices and has reached a timeout.

forward-when-unregistered

object (AnswerruleFeature)

optional

This feature will allow forwarding the call when there are no devices registered (or push enabled devices).

forward-on-dnd

object (AnswerruleFeature)

optional

forward-on-spam-call

object (AnswerruleFeature)

optional

This feature will allow forwarding the call to a new application when a inbound SPAM flag has been set.

call-screening

object

optional

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.

enabled

enum<string>

required

This settings will control if the the parent feature is enabled.

Allowed values:

yesno

Default:

phone-numbers-to-allow

object (AnswerruleFeatureWithRemove)

optional

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

enabled

enum<string>

required

This settings will control if the the parent feature is enabled.

Allowed values:

yesno

Default:

remove

enum<string>

optional

Used for accept and reject numbers will allow for the numebrs that are provided to be removed from the list

Allowed values:

yesno

Default:

parameters

array [anyOf]

optional

This field will provide the values needed to configure the parent feature. These values could be multiple strings or numbers.

new-position

enum<string>

write-onlyoptional

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

topbottom

Examples:

topbottom

phone-numbers-to-reject

object (AnswerruleFeatureWithRemove)

optional

This is a list of numbers that would be blocked and rejected before any forward or sim ring features are attempted.

Example

{
  "time-frame": "Vacation",
  "enabled": "yes",
  "forward-always": {
    "enabled": "no",
    "parameters": [
      18587645226
    ]
  },
  "forward-on-busy": {
    "enabled": "no",
    "parameters": []
  },
  "do-not-disturb": {
    "enabled": "no"
  },
  "forward-when-unregistered": {
    "enabled": "yes",
    "parameters": [
      18585551354
    ]
  },
  "phone-numbers-to-reject": {
    "enabled": "yes",
    "parameters": [
      "anonymous",
      "unknown"
    ]
  },
  "forward-on-active": {
    "enabled": "no",
    "parameters": [
      12545666,
      "id adipisicing est veniam",
      "ad"
    ]
  },
  "forward-no-answer": {
    "enabled": "no",
    "parameters": [
      6154343
    ]
  },
  "forward-on-spam-call": {
    "enabled": "yes",
    "parameters": [
      "vmail_1000"
    ]
  },
  "call-screening": {
    "enabled": "no"
  },
  "simultaneous-ring": {
    "enabled": "no",
    "parameters": [
      1234,
      3245,
      "1231wp",
      18587645200
    ]
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Request

Request samples

Responses