Inbound rules

List inbound rules

Retrieve a collection of inbound rules

GEThttp://127.0.0.1:8888/api/inbound_rules

Query parameters

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/inbound_rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

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.

POSThttp://127.0.0.1:8888/api/inbound_rules

Body

application/json

name*string

Inbound rule name.

enabledboolean

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_numbers*string

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

did_numbers_as_to_headerboolean

Whether to user DID numbers as invite To header.

office_hours_forward_ruleobject

non_office_hours_forward_ruleobject

holiday_forward_ruleobject

office_hoursall of

holidaysarray of all of

A collection of ID of tenant's holiday.

provider_id*all of

The unique ID of trunk.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of inbound rule.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/inbound_rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "did_numbers": "text",
      "provider_id": {}
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve an inbound rule

Retrieve an inbound rule.

GEThttp://127.0.0.1:8888/api/inbound_rules/{id}

Path parameters

id*all of

The unique ID of inbound rule.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of inbound rule.

namestring

Inbound rule name.

enabledboolean

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

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

did_numbers_as_to_headerboolean

Whether to user DID numbers as invite To header.

office_hours_forward_ruleobject

non_office_hours_forward_ruleobject

holiday_forward_ruleobject

office_hoursall of

holidaysarray of object

A collection of tenant's holiday.

provider_idall of

The unique ID of trunk.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/inbound_rules/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Update an inbound rule

Update an inbound rule.

POSThttp://127.0.0.1:8888/api/inbound_rules/{id}

Path parameters

id*all of

The unique ID of inbound rule.

Body

application/json

namestring

Inbound rule name.

enabledboolean

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

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

did_numbers_as_to_headerboolean

Whether to user DID numbers as invite To header.

office_hours_forward_ruleobject

non_office_hours_forward_ruleobject

holiday_forward_ruleobject

office_hoursall of

holidaysarray of all of

A collection of ID of tenant's holiday.

provider_idall of

The unique ID of trunk.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/inbound_rules/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();