Outbound rules

List outbound rules

Retrieve a collection of outbound rules.

GEThttp://127.0.0.1:8888/api/outbound_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/outbound_rules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "number_prefix": "text",
      "number_length": "text",
      "number_mask": "text",
      "enabled": true,
      "priority": 1000,
      "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
        }
      ],
      "routing_strategy": "PRIORITIZED"
    }
  ]
}

Create a outbound rule

Add a new outbound rule.

POSThttp://127.0.0.1:8888/api/outbound_rules

Body

application/json

name*string

The name of outbound rule.

number_prefixstring

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.

number_lengthstring

The length of number prefix.
A semicolon-separated list of integer.
For example by specifying "1;2", calls with a caller ID of 1 or 2 digits will be applied this rule.

number_maskstring

Extension who starts the call. A semicolon-separated list of extensions allowed. For example by specifying "101-110;199", extensions from 101 to 110 and 199 will be applied this rule.

enabledboolean

Whether to enable outbound rule.

priorityinteger (int32)

The priority of outbound rule.

office_hoursall of

holidaysarray of all of

A collection ID of tenant's holidays.

routing_strategyenum

Routing strategy:
Can be either:

• PRIORITIZED: Selected according to the priority order of the route list.
• RANDOMLY: Randomly select one of the route list.

PRIORITIZEDRANDOMLY

routesarray of object

Response

2014XX

Created outbound rule

Body

application/json

idall of

The unique ID of outbound rule.

Request

JavaScriptCurlPython

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

Response

201

{
  "id": {}
}

Retrieve a outbound rule

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

Path parameters

id*all of

The unique ID of outbound rule.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of outbound rule.

namestring

The name of outbound rule.

number_prefixstring

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.

number_lengthstring

The length of number prefix.
A semicolon-separated list of integer.
For example by specifying "1;2", calls with a caller ID of 1 or 2 digits will be applied this rule.

number_maskstring

Extension who starts the call. A semicolon-separated list of extensions allowed. For example by specifying "101-110;199", extensions from 101 to 110 and 199 will be applied this rule.

enabledboolean

Whether to enable outbound rule.

priorityinteger (int32)

The priority of outbound rule.

office_hoursall of

holidaysarray of object

A collection of tenant's holidays.

routing_strategyenum

Routing strategy:
Can be either:

• PRIORITIZED: Selected according to the priority order of the route list.
• RANDOMLY: Randomly select one of the route list.

PRIORITIZEDRANDOMLY

routesarray of object

Request

JavaScriptCurlPython

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

Response

200

{
  "id": {},
  "name": "text",
  "number_prefix": "text",
  "number_length": "text",
  "number_mask": "text",
  "enabled": true,
  "priority": 1000,
  "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
    }
  ],
  "routing_strategy": "PRIORITIZED",
  "routes": [
    {
      "enabled": false,
      "provider_id": {},
      "strip_digits": 0,
      "prepend": "text",
      "outbound_caller_id": {}
    }
  ]
}

Update a outbound rule

Update properties of outbound rule by it's unique ID.

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

Path parameters

id*all of

The unique ID of outbound rule.

Body

application/json

idall of

The unique ID of outbound rule.

namestring

The name of outbound rule.

number_prefixstring

Prefix of callee ID. Calls started with this prefix will be applied this outbound rule.

number_lengthstring

The length of number prefix.
A semicolon-separated list of integer.
For example by specifying "1;2", calls with a caller ID of 1 or 2 digits will be applied this rule.

number_maskstring

Extension who starts the call. A semicolon-separated list of extensions allowed. For example by specifying "101-110;199", extensions from 101 to 110 and 199 will be applied this rule.

enabledboolean

Whether to enable outbound rule.

priorityinteger (int32)

The priority of outbound rule.

office_hoursall of

holidaysarray of all of

A collection ID of tenant's holidays.

routing_strategyenum

Routing strategy:
Can be either:

• PRIORITIZED: Selected according to the priority order of the route list.
• RANDOMLY: Randomly select one of the route list.

PRIORITIZEDRANDOMLY

routesarray of object

Response

2004XX

OK

Request

JavaScriptCurlPython

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