Menu
Platform
- Accounts and projects
- Regions
- Environments
- Keys and scopes
- Plans, usage and limits
- Errors
- API versions
- API reference
- CLI
- MCP
- Published CLI compatibility
- Terraform
- Management secret deletion
- API keys
- Artifacts
- Connection providers
- Connections
- Envs
- Key versions
- Keys
- Projects
- Secret versions
- Secrets
- Service enablements
- Token exchanges
- Trust policies
AI
Alerts and status pages
App store purchases
Credits
Database
Flags
Generated Assets
Hosting
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a phone number
GetPhoneNumber: existing provider-managed lines; execution credentials are transient.
GetPhoneNumber: existing provider-managed lines; execution credentials are transient.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number - Scope
notify:read - Effect
read— nothing is written. - Collection phone_numbers
#Request
| Field | Type | What it is |
|---|---|---|
name | string | Resource to read. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#PhoneNumberSpec
| Field | Type | What it is |
|---|---|---|
phone_number | string | Existing E.164 number, verified against authenticated provider inventory. Required. |
provider | string | Provider adapter; currently switchboard_free. Required. |
voicemail | PhoneVoicemailRoute | Desired route, admitted only through applyRoute with a durable operation id. |
#PhoneNumberStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | Generation represented by these observations. Output only. |
conditions | Condition[] | Connected, RouteApplied and IncomingVerified are independent conditions. Output only. |
provider_principal | string | Opaque hash of the provider-accepted session principal; never its login name. Output only. |
provider_line_id | string | Immutable provider line identity. Output only. |
provider_number_id | string | Immutable provider number identity. Output only. |
observed_voicemail | PhoneVoicemailRoute | Last provider readback, independent of desired state. Output only. |
applied_generation | int64 | Generation confirmed by provider readback. Output only. |
incoming_verified_generation | int64 | Generation with a scoped incoming voicemail recording delivered to its intended mailbox. Output only. |
last_error | string | Safe error classification; never a provider body or credential. Output only. |
observed_path_digest | string | Safe hash of the full last-observed provider call-path configuration. Output only. |
applied_path_digest | string | Incoming-proof baseline, cleared on observed external path changes. Output only. |
#PhoneVoicemailRoute
| Field | Type | What it is |
|---|---|---|
enabled | bool | Whether voicemail is enabled. Required. |
delay_seconds | int32 | Provider wait before offering voicemail, in seconds; at most 600. Forced transfer is separate provider configuration and is preserved. Required. |
email_address | string | Intended recording-delivery address. Required. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.UNAVAILABLE— The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/phone_numbers/phone-number" \
-H "Authorization: Bearer $SYLPHX_API_KEY"