Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
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
On this page
Get an inbound sm
Gets one inbound SMS.
Gets one inbound SMS.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number/inbound_sms/inbound-sms - Scope
notify:read - Effect
read— nothing is written. - Collection inbound_sms
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the inbound SMS to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}/inbound_sms/{inbound_sms}. |
uid | string | isms_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
sequence | int64 | The feed position, increasing within the environment; filter sequence > N to resume after the last one handled. Output only. |
carrier_message_id | string | The carrier's id for this message; the dedupe key on the number binding. Output only. |
sender_number | string | The sender, in E.164 when the carrier gave one. Output only. |
recipient_number | string | The number the message was sent to, in E.164. Output only. |
text | string | The text. Empty once retention has cleared it. Output only. |
segments | int32 | How many segments the carrier counted. Output only. |
receive_time | timestamp | When the carrier says it received the message. Output only. |
cleared | bool | The text has been cleared by retention; the dedupe key stays. 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. |
#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/sms_numbers/sms-number/inbound_sms/inbound-sms" \
-H "Authorization: Bearer $SYLPHX_API_KEY"