Outbound rules

List outbound rules

get

Retrieve a collection of outbound rules.

Authorizations

Query parameters

filterstringoptional

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

searchstringoptional

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

orderbystringoptional

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

skipinteger · int32 · default: 0optional

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: 100optional

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Create a outbound rule

post

Add a new outbound rule.

Authorizations

Body

namestring · min: 1 · max: 64required

The name of outbound rule.

number_prefixstring · max: 64optional

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

number_lengthstring · max: 64optional

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_maskstringoptional

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 · default: trueoptional

Whether to enable outbound rule.

priorityinteger · int32 · default: 1000optional

The priority of outbound rule.

office_hoursall ofoptional

holidaysall of[]optional

A collection ID of tenant's holidays.

routing_strategystring · enum · default: "PRIORITIZED"optional

Routing strategy:
Can be either:

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

Options: PRIORITIZED, RANDOMLY

routesobject[]optional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/outbound_rules' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "number_prefix": "text",
    "number_length": "text",
    "number_mask": "text",
    "enabled": true,
    "priority": 1,
    "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"
          }
        ]
      }
    },
    "holidays": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "routing_strategy": "PRIORITIZED",
    "routes": [
      {
        "enabled": true,
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
        "strip_digits": 1,
        "prepend": "text",
        "outbound_caller_id": "text"
      }
    ]
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created outbound rule

Retrieve a outbound rule

get

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

The unique ID of the resource.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

4XX

200

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

OK

Update a outbound rule

post

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

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

The unique ID of the resource.

Body

idall ofoptional

The unique ID of outbound rule.

The unique ID of the resource.

namestring · min: 1 · max: 64optional

The name of outbound rule.

number_prefixstring · max: 64optional

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

number_lengthstring · max: 64optional

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_maskstringoptional

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 · default: trueoptional

Whether to enable outbound rule.

priorityinteger · int32 · default: 1000optional

The priority of outbound rule.

office_hoursall ofoptional

holidaysall of[]optional

A collection ID of tenant's holidays.

routing_strategystring · enum · default: "PRIORITIZED"optional

Routing strategy:
Can be either:

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

Options: PRIORITIZED, RANDOMLY

routesobject[]optional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/outbound_rules/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
    "name": "text",
    "number_prefix": "text",
    "number_length": "text",
    "number_mask": "text",
    "enabled": true,
    "priority": 1,
    "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"
          }
        ]
      }
    },
    "holidays": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "routing_strategy": "PRIORITIZED",
    "routes": [
      {
        "enabled": true,
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
        "strip_digits": 1,
        "prepend": "text",
        "outbound_caller_id": "text"
      }
    ]
  }'

200

4XX

200

No body

OK