Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Phone numbers

A connected, existing provider-managed telephone line.

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

FieldTypeWhat it is
namestringThe resource name.
uidstringImmutable pnum_ identifier. Output only.
metaResourceMetaResource metadata.
specPhoneNumberSpecThe connected line and desired voicemail route. Required.
statusPhoneNumberStatusAuthoritative 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.

MethodCallWhat it does
POSTconnectConnectPhoneNumber: existing provider-managed lines; execution credentials are transient.
GETgetGetPhoneNumber: existing provider-managed lines; execution credentials are transient.
GETlistListPhoneNumbers: existing provider-managed lines; execution credentials are transient.
POSTapply_routeApplyPhoneNumberRoute: existing provider-managed lines; execution credentials are transient.
POSTprobeProbePhoneNumber: existing provider-managed lines; execution credentials are transient.
POSTread_voicemailReadPhoneNumberVoicemail: 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

#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

#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

#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

#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

#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