Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Outbound Rule

Update a outbound rule

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

post/outbound_rules/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the outbound rule.

Request body

idstring

The unique ID of the resource.

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

The priority of outbound rule.

holidaysstring[]

A collection ID of tenant's holidays.

routing_strategy'PRIORITIZED' | 'RANDOMLY'

Routing strategy:
Can be either:

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

Example request

{
  "id": "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"
        }
      ]
    }
  },
  "holidays": [
    "NzAwNTUxOTA5NzczMTQ4MTYw"
  ],
  "routes": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Response

OK