---
title: "Create an inbound routing rule"
method: POST
path: "/voice/inbound-routing/rules"
tags: ["Voice"]
---

# Create an inbound routing rule

`POST /voice/inbound-routing/rules`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/voice/inbound-routing/rules`
- Auth: HTTP bearer

Decide where calls on one number go.

THIS CHANGES WHAT HAPPENS TO REAL CALLERS as soon as it is active. A rule
with a lower `priority` than an existing one takes precedence over it, so
creating a rule can silently retire the one that was working.

`target_type` and `ring_strategy` are closed to voice's own sets. `org_id`
is absent from the body and pinned from the key.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- InboundRouteCreateRequest: A rule deciding where an inbound call on one number goes. `org_id` is absent on purpose - pinned from the key by the router. Rules are evaluated by ascending `priority`; the first whose `match_conditions` hold wins.
  - `phone_number` string, required: The number this rule applies to.
  - `priority` integer: Lower wins. Ties are resolved arbitrarily.
  - `name` string, nullable
  - `match_conditions` object: `{"always": true}` or a `{"schedule": {...}}` block with `days`, `start_time`/`end_time` as HH:MM, and an IANA `timezone`.
  - `target_type` 'ai_agent' | 'department' | 'extension' | 'voicemail', required
  - `target_id` string, nullable: Agent id, department or extension - depends on `target_type`.
  - `ring_strategy` 'single' | 'round_robin'
  - `queue_max_wait_seconds` integer, nullable
  - `is_active` boolean

## Response `201`

Successful Response

- ApiResponseVoicePayload
  - `data` VoicePayload, required: One voice object - a collection, an agent, a route, a chat. Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)