Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a sender
Gets a sender.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets a sender.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender - Scope
notify:read - Effect
read— nothing is written. - Collection senders
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the sender to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/senders/{sender}. |
uid | string | snd_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | SenderSpec | Desired state. Required. |
status | SenderStatus | Observed state. 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. |
#SenderSpec
| Field | Type | What it is |
|---|---|---|
sms | SmsSender | An SMS number or alphanumeric sender id. One of the channel group. |
push | PushSender | A mobile or web push app. One of the channel group. |
#SenderStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
verified | bool | Whether the sender is registered and usable. Output only. |
verification_note | string | Why the sender is not verified, when it is not. Output only. |
#SmsSender
| Field | Type | What it is |
|---|---|---|
phone_number | string | An E.164 number. One of the origin group. |
sender_key | string | An alphanumeric sender id, where the region allows one. One of the origin group. |
region_codes | string[] | CLDR region codes the origin is registered for. |
#PushSender
| Field | Type | What it is |
|---|---|---|
platform | PushPlatform | The push platform. Required. One of apns, fcm, web_push. |
connection | string | The Connection holding the APNs, FCM, or VAPID credentials. Required. |
app_key | string | The bundle id, package name, or web origin. 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.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/senders/sender" \
-H "Authorization: Bearer $SYLPHX_API_KEY"