---
title: "Register a number with the voice platform"
method: POST
path: "/voice/numbers/provision"
tags: ["Phone Numbers"]
---

# Register a number with the voice platform

`POST /voice/numbers/provision`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/voice/numbers/provision`
- Auth: HTTP bearer

Wire an already-owned number into the voice platform.

BUYS NOTHING. Voice calls this operation `purchase` and it is published
here as `provision` deliberately: it creates SIP trunks and dispatch rules
for a number you already hold, while `POST /phone-numbers/purchase` is the
one that spends credits and buys a DID. Two operations both called
"purchase", one of which takes money and one of which does not, is not a
distinction to leave to a docstring.

IDEMPOTENT: a number already registered comes back as success rather than
an error, and an unverified Telnyx number has its caller-ID verification
re-queued on the way through.

Reach for this to repair a purchase whose voice half failed, or to adopt a
number bought outside graph8. `org_id` is taken from the API key.

## Headers

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

## Request body

- VoiceNumberProvisionRequest: Register an already-owned number with the voice platform. Mirrors `graph8_livekit.schemas.numbers.Number` field-for-field EXCEPT `org_id`, which is taken from the API key and can never be sent - see the router docstring. `number`, not `phone_number`: this is voice's field name, and the proxy sends voice's own wire shape rather than inventing a translation layer that would have to be kept in step with it.
  - `number` string, required: The number to register, E.164. You must already own it.
  - `provider` 'twilio' | 'telnyx': Which carrier holds the number.
  - `inbound_type` 'ai' | 'sdr' | 'dialer' | 'work', nullable: How inbound calls are answered. Ignored when `dialer` or `work` is set - those paths provision no LiveKit trunks at all and the type is forced to `dialer` / `work` respectively.
  - `dialer` boolean: Provision as a dialer number (no LiveKit).
  - `work` boolean: Provision as someone's personal work phone. Implies `dialer`.
  - `assigned_to` string, nullable: Email of the person this number rings for. REQUIRED in practice for a `work` number: without it no phone-directory row is created, so the receptionist can never route to them by name.

## Response `200`

Successful Response

- ApiResponsePhoneNumberPayload
  - `data` PhoneNumberPayload, required: An open envelope for a purchase result, a release, or an A2P job. Open on purpose. A purchase returns the stored row (whose capability and provider-metadata keys differ per provider), a workflow start returns a `workflow_id`, and the A2P reconcile returns per-number outcomes that grow as carriers add statuses. Pinning it would silently drop whatever the provider reported that this contract had not caught up on.
  - `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)