NSns-api
Answer Rules

Read Answerrules for a User

Changed on
get/domains/{domain}/users/{user}/answerrules

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/domains/{domain}/users/{user}/answerrules
  • Auth
    HTTP bearer

Path parameters

domainstring required

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.

Example:example.com
userstring required

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.

Example:1000

Response

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

userstring required

This is the main user extension for the user account.

time-framestring 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'yes' | 'no' required
is-activeboolean required

This is read only option that will be true if this timeframe is active for this user when taking into account current settings, date/time and all timeframes.

orderinteger

This is to allow for a priority based order of different timeframes. The default is to add it in value higher (lower priority) than the lowest priority timeframe. Timeframe * will get 99 if not already set.

new-position'top' | 'bottom'

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

Example response

[
  {
    "domain": "example.com",
    "user": "1000",
    "simultaneous-ring": {
      "parameters": [
        "1234wp"
      ]
    },
    "forward-always": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-on-active": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-on-busy": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-no-answer": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-when-unregistered": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-on-dnd": {
      "parameters": [
        "park_1234"
      ]
    },
    "forward-on-spam-call": {
      "parameters": [
        "park_1234"
      ]
    },
    "phone-numbers-to-allow": {
      "parameters": [
        "park_1234"
      ]
    },
    "new-position": "top",
    "phone-numbers-to-reject": {
      "parameters": [
        "park_1234"
      ]
    },
    "time_range_data": [
      {
        "start-date": "2023-08-20",
        "end-date": "2023-09-15",
        "day-of-week-number": "*",
        "start-time": "00:00",
        "end-time": "23:59"
      }
    ]
  }
]

Changes

  • bce16087d479Revision changes
    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the required property /// to the response with the status