Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Inbound Rule

Update an inbound rule

Update an inbound rule.

post/inbound_rules/{id}

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the inbound rule.

Request body

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.

holidaysstring[]

A collection of ID of tenant's holiday.

provider_idstring

The unique ID of the resource.

enable_advanced_routingboolean

Whether to enable advanced routing.

advanced_routingstring

Advanced routing rules.

play_recording_disclaimerboolean

Whether to play recording disclaimer to inbound calls.

Example request

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

Response

OK