Outbound rules

List outbound rules

Retrieve a collection of outbound rules.

get

/outbound_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 · default: 0

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

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

200

4XX

200

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

OK

Create a outbound rule

Add a new outbound rule.

post

/outbound_rules

Authorizations

Body

namestring · min: 1 · max: 64required

The name of outbound rule.

number_prefixstring · max: 64

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

number_lengthstring · max: 64

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

Whether to enable outbound rule.

priorityinteger · int32 · default: 1000

The priority of outbound rule.

routing_strategystring · enum · default: PRIORITIZED

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

holidaysall of[]

The unique ID of holiday.

routesobject[]

office_hoursall of

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": 1000,
    "routing_strategy": "PRIORITIZED",
    "holidays": [
      "NzAwNTUxOTA5NzczMTQ4MTYw"
    ],
    "routes": [
      {
        "enabled": true,
        "strip_digits": 0,
        "prepend": "text",
        "outbound_caller_id": "text",
        "provider_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"
          }
        ]
      }
    }
  }'

201

4XX

201

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created outbound rule

Retrieve a outbound rule

get

/outbound_rules/{id}

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

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

OK

Update a outbound rule

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

post

/outbound_rules/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of outbound rule.

The unique ID of the resource.

Body

namestring · min: 1 · max: 64

The name of outbound rule.

number_prefixstring · max: 64

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

number_lengthstring · max: 64

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

Whether to enable outbound rule.

priorityinteger · int32 · default: 1000

The priority of outbound rule.

routing_strategystring · enum · default: PRIORITIZED

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

idall of

The unique ID of outbound rule.

The unique ID of the resource.

holidaysall of[]

The unique ID of holiday.

routesobject[]

office_hoursall of

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

200

4XX

200

No body

OK