<Intro>

<EndpointHeader />

<Description>

Returns a single phone number allocated to your workspace, whether it is a dedicated number you bought or a shared number managed for you. Numbers you have released are no longer returned. Holding a number is not always enough to send from it: some countries also require an approved registration for the sender.

</Description>

</Intro>

<Parameters in="path">

<Parameter name="number_id" type="string">

<Description>

Identifier of the number, as returned in the id field of GET /v1/numbers.

</Description>

</Parameter>

</Parameters>

<Payload kind="response">

<Field name="id" type="string" required>

<Description>

Identifier of this allocated number. Pass it as `number_id` to read this number, or to release it when kind is dedicated.

</Description>

</Field>

<Field name="kind" type="string" required>

<Description>

How this number is allocated to the workspace. `dedicated` is owned solely by this workspace and billed as a subscription. `shared` is a shortcode shared across workspaces and managed by us.

</Description>

<Description>

Possible values: `dedicated`, `shared`

</Description>

</Field>

<Field name="number" type="string" required>

<Description>

Phone number in E.164 format.

</Description>

</Field>

<Field name="country_code" type="string" required />

<Field name="number_type" type="string" required>

<Description>

Physical type of this phone number.

</Description>

</Field>

<Field name="capabilities" type="array of string" required>

<Description>

Channel capabilities supported by this number.

</Description>

</Field>

<Field name="status" type="string" required>

<Description>

Whether this number can carry traffic.

- `active` means this number is allocated to your workspace and usable.
- `pending_compliance` means this number is allocated to your workspace and billed,
  but it cannot carry traffic until the ownership paperwork its country requires is
  accepted. Read `ownership.next` for what advances it, and re-read later if
  `ownership` is momentarily `null`.
- `released` means this number is no longer allocated to your workspace.

Holding a number is not always enough to send from it: some destination countries
also require an approved registration for the sender.

</Description>

<Description>

Possible values: `active`, `pending_compliance`, `released`

</Description>

</Field>

<Field name="allocated_at" type="string" required>

<Description>

When this number was allocated to your workspace.

</Description>

</Field>

<Field name="released_at" type="nullable string">

<Description>

When this number was released. `null` while it is still allocated to your workspace.

</Description>

</Field>

<Field name="ownership" type="nullable object">

<Description>

Where this number stands with the ownership paperwork its country requires. `null` when the country requires none, which is the usual case: a number with no `ownership` object is usable as soon as it is allocated. Also `null` when that standing cannot be established right now; `status` still reads `pending_compliance` while the number is blocked, so re-read this field rather than caching its absence. We manage the paperwork for shared short codes, so this field is always `null` for them.

</Description>

<FieldChildren kind="response">

<Field name="satisfied" type="boolean" prefix="ownership." required>

<Description>

Whether the paperwork is accepted. Read `next` for what advances it while this is false. Whether sending is currently refused is reported by `blocked_at` instead: a number bought before its country asked for anything is unsatisfied and still usable until a review says otherwise.

</Description>

</Field>

<Field name="blocked_at" type="nullable string" prefix="ownership.">

<Description>

When the number stopped being able to carry traffic, and null while it can. Always null when `satisfied` is true, but null does not imply it: a number whose country began asking after you bought it is usable with its paperwork still outstanding. A number can also arrive blocked, and one that was usable can be blocked again if its approval is withdrawn.

</Description>

</Field>

<Field name="next" type="array of object" prefix="ownership." required>

<Description>

What you do about it, in the order to do it. Empty only when `satisfied` is true, so while anything is outstanding there is always at least one step. When what you already sent is being reviewed and nothing is needed from you, that step has kind `wait` and says so. Re-read it after each call rather than caching the first list you saw.

</Description>

<FieldChildren kind="response">

<Field name="kind" type="string" prefix="ownership.next." required>

<Description>

What you do about this step.

- `operation`: call the operation named in `operation`, then
  read again.
- `external`: act somewhere this API does not reach, then read
  again.
- `wait`: nothing is asked of you, so read again later.
- `terminal`: nothing you do resolves this, so stop retrying.

Tolerate a value you do not recognize: show the `description` and
offer no action.

</Description>

<Description>

Possible values (may grow over time): `operation`, `external`, `wait`, `terminal`

</Description>

</Field>

<Field name="description" type="string" prefix="ownership.next." required>

<Description>

A short, human-readable label for the step, suitable for display.

</Description>

</Field>

<Field name="operation" type="string" prefix="ownership.next.">

<Description>

The operationId to call. Present only when `kind` is `operation`. The operation's own schema says how to call it; this says only which one, and what to address it with.

</Description>

</Field>

<Field name="params" type="object" prefix="ownership.next.">

<Description>

The parameters that address the operation, by name: `{"sender_id": "…"}` for an operation on `/v1/sms/senders/{sender_id}/requirements`. A parameter the operation takes in its query string is given the same way, so an operation addressed as `?subject_id=` carries `{"subject_id": "…"}`. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when `kind` is `operation` and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.

</Description>

</Field>

<Field name="url" type="string" prefix="ownership.next.">

<Description>

A URL to open. Present only when `kind` is `external`, and only when the step has one. An external step whose `description` says to go and do something with no URL to open is normal.

</Description>

</Field>

</FieldChildren>

</Field>

</FieldChildren>

</Field>

</Payload>