Inbound rules

PreviousDestroy NextDestroy

Was this helpful?

List inbound rules

Retrieve a collection of inbound rules

get

/inbound_rules

Authorizations

Query parameters

filterstring

Use the filter query parameter to retrieve just a subset of a collection.

searchstring

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystring

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32

Use the skip query parameter to set the number of items to skip at the start of a collection.

topinteger · int32 · min: 1 · max: 100 · default: 100

Use the top query parameter to specify the page size of the result set.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/inbound_rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "enabled": true,
      "cid_number_mask": "text",
      "did_numbers": "text",
      "enable_advanced_routing": false,
      "advanced_routing": "text",
      "play_recording_disclaimer": false,
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "office_hours_forward_rule": {
        "number": "text",
        "action": "FORWARD_TO_NUMBER"
      },
      "non_office_hours_forward_rule": {
        "number": "text",
        "action": "FORWARD_TO_NUMBER"
      },
      "holiday_forward_rule": {
        "number": "text",
        "action": "FORWARD_TO_NUMBER"
      },
      "holidays": [
        {
          "name": "text",
          "every_year": true,
          "consecutive": true,
          "year_start": 1,
          "year_end": 1,
          "month_start": 1,
          "month_end": 1,
          "day_start": 1,
          "day_end": 1,
          "hour_start": 1,
          "hour_end": 1,
          "minute_start": 1,
          "minute_end": 1,
          "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
        }
      ],
      "office_hours": {
        "mode": "CUSTOM",
        "monday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      }
    }
  ]
}

Create an inbound rule

Add a new inbound rule. Please make sure you have at least one provider created before creating a new inbound rule.

post

/inbound_rules

Authorizations

Body

namestring · min: 1 · max: 64required

Inbound rule name.

enabledboolean · default: true

Enabled or not.

cid_number_maskstring

The CID number Mask for inbound rule.
You can add the number in it's entirety, identifying a single caller,
or use the * as a wildcard. For example 0044********** will identify a UK Caller and 004420******** will identify a caller from London.
Note: the * digits must matched number actually digits. If the number is 3 digits, then should use *** The CID number mask also allow set a number range, for example: 00442012345670-00442012345680.

did_numbersstring · min: 1required

A single DID/DDI number or a hyphen-separated range of DID/DDI numbers.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

provider_idall ofrequired

The unique ID of trunk.

office_hours_forward_ruleobject

non_office_hours_forward_ruleobject

holiday_forward_ruleobject

holidaysall of[]

A collection of ID of tenant's holiday.

office_hoursall of

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/inbound_rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","enabled":true,"did_numbers":"text","enable_advanced_routing":false,"play_recording_disclaimer":false,"provider_id":"NzAwNTUxOTA5NzczMTQ4MTYw","office_hours_forward_rule":{"action":"FORWARD_TO_NUMBER"},"non_office_hours_forward_rule":{"action":"FORWARD_TO_NUMBER"},"holiday_forward_rule":{"action":"FORWARD_TO_NUMBER"},"holidays":["NzAwNTUxOTA5NzczMTQ4MTYw"],"office_hours":{"mode":"CUSTOM","monday":{"ranges":[{"from":"09:00","to":"17:00"}]},"tuesday":{"ranges":[{"from":"09:00","to":"17:00"}]},"wednesday":{"ranges":[{"from":"09:00","to":"17:00"}]},"thursday":{"ranges":[{"from":"09:00","to":"17:00"}]},"friday":{"ranges":[{"from":"09:00","to":"17:00"}]},"saturday":{"ranges":[{"from":"09:00","to":"17:00"}]},"sunday":{"ranges":[{"from":"09:00","to":"17:00"}]}}}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve an inbound rule

Retrieve an inbound rule.

get

/inbound_rules/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of inbound rule.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/inbound_rules/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "enabled": true,
  "cid_number_mask": "text",
  "did_numbers": "text",
  "enable_advanced_routing": false,
  "advanced_routing": "text",
  "play_recording_disclaimer": false,
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "holiday_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "holidays": [
    {
      "name": "text",
      "every_year": true,
      "consecutive": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1,
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ],
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  }
}

Update an inbound rule

Update an inbound rule.

post

/inbound_rules/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of inbound rule.

Body

namestring · min: 1 · max: 64

Inbound rule name.

enabledboolean · default: true

Enabled or not.

cid_number_maskstring

did_numbersstring · min: 1

A single DID/DDI number or a hyphen-separated range of DID/DDI numbers.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

provider_idall of

The unique ID of trunk.

office_hours_forward_ruleobject

non_office_hours_forward_ruleobject

holiday_forward_ruleobject

holidaysall of[]

A collection of ID of tenant's holiday.

office_hoursall of

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/inbound_rules/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"enabled":true,"enable_advanced_routing":false,"play_recording_disclaimer":false,"provider_id":"NzAwNTUxOTA5NzczMTQ4MTYw","office_hours_forward_rule":{"action":"FORWARD_TO_NUMBER"},"non_office_hours_forward_rule":{"action":"FORWARD_TO_NUMBER"},"holiday_forward_rule":{"action":"FORWARD_TO_NUMBER"},"holidays":["NzAwNTUxOTA5NzczMTQ4MTYw"],"office_hours":{"mode":"CUSTOM","monday":{"ranges":[{"from":"09:00","to":"17:00"}]},"tuesday":{"ranges":[{"from":"09:00","to":"17:00"}]},"wednesday":{"ranges":[{"from":"09:00","to":"17:00"}]},"thursday":{"ranges":[{"from":"09:00","to":"17:00"}]},"friday":{"ranges":[{"from":"09:00","to":"17:00"}]},"saturday":{"ranges":[{"from":"09:00","to":"17:00"}]},"sunday":{"ranges":[{"from":"09:00","to":"17:00"}]}}}'

200

4XX

No body