---
# @generated by sylphx-gen. Do not edit.
title: "Phone numbers"
description: "The `phone_numbers` collection of Sylphx Notify: A connected, existing provider-managed telephone line."
type: reference
product: notifications
summary: "A connected, existing provider-managed telephone line."
updated: 2026-09-28
order: 900
---

A connected, existing provider-managed telephone line. The provider answers calls and records voicemail; Notify controls its route on demand. Connecting never orders a number or changes a provider subscription.

**Service** Sylphx Notify · **Resource type** `notify.sylphx.com/PhoneNumber` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/phone_numbers/{phone_number}` · **Shape** `spec_status`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The resource name. |
| `uid` | `string` | Immutable pnum_ identifier. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `PhoneNumberSpec` | The connected line and desired voicemail route. Required. |
| `status` | `PhoneNumberStatus` | Authoritative observations, with route application separate from incoming verification. Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `POST` | [`connect`](/docs/api/phone_numbers#connect) | ConnectPhoneNumber: existing provider-managed lines; execution credentials are transient. |
| `GET` | [`get`](/docs/api/phone_numbers#get) | GetPhoneNumber: existing provider-managed lines; execution credentials are transient. |
| `GET` | [`list`](/docs/api/phone_numbers#list) | ListPhoneNumbers: existing provider-managed lines; execution credentials are transient. |
| `POST` | [`apply_route`](/docs/api/phone_numbers#apply-route) | ApplyPhoneNumberRoute: existing provider-managed lines; execution credentials are transient. |
| `POST` | [`probe`](/docs/api/phone_numbers#probe) | ProbePhoneNumber: existing provider-managed lines; execution credentials are transient. |
| `POST` | [`read_voicemail`](/docs/api/phone_numbers#read-voicemail) | ReadPhoneNumberVoicemail: existing provider-managed lines; execution credentials are transient. |

## connect

ConnectPhoneNumber: existing provider-managed lines; execution credentials are transient.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers:connect` · scope `notify:write` · effect `write` · validate_only · [Request, response and examples](/docs/api/phone_numbers/connect)

## get

GetPhoneNumber: existing provider-managed lines; execution credentials are transient.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/phone_numbers/get)

## list

ListPhoneNumbers: existing provider-managed lines; execution credentials are transient.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers` · scope `notify:read` · effect `read` · paginated · [Request, response and examples](/docs/api/phone_numbers/list)

## apply_route

ApplyPhoneNumberRoute: existing provider-managed lines; execution credentials are transient.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:applyRoute` · scope `notify:write` · effect `write` · validate_only · [Request, response and examples](/docs/api/phone_numbers/apply_route)

## probe

ProbePhoneNumber: existing provider-managed lines; execution credentials are transient.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:probe` · scope `notify:write` · effect `write` · [Request, response and examples](/docs/api/phone_numbers/probe)

## read_voicemail

ReadPhoneNumberVoicemail: existing provider-managed lines; execution credentials are transient.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number:readVoicemail` · scope `notify:read` · effect `read` · [Request, response and examples](/docs/api/phone_numbers/read_voicemail)