Menu
Platform
AI
Alerts and status pages
App store purchases
Credits
Generated Assets
Knowledge
KV
Localization
Notifications
Organizations
Payments
Queues
Realtime
Sandboxes
Storage
Workflows
API reference
- Overview
- Access API keys
- Agent sessions API
- Agent versions API
- Agents API
- AI models API
- Artifact references API
- Artifacts API
- Assets API
- Auth configs API
- Bank receipts API
- Bank transfer accounts API
- Buckets API
- Builds API
- Catalogs API
- Chat profiles API
- Chat reports API
- Chat sticker packs API
- Checkout policies API
- Checkout sessions API
- Config changes API
- Config flags API
- Config segments API
- Connection providers API
- Connections API
- Connectors API
- Credit grants API
- Customer organizations API
- Customer subscriptions API
- Databases API
- Documents API
- Email domains API
- End users API
- Entities API
- Entitlement grants API
- Entries API
- Environments API
- Episodes API
- Error events API
- Error groups API
- Events API
- Exchange rates API
- Generations API
- Glossaries API
- Goals API
- Identities API
- Inbound emails API
- Inbound endpoints API
- Inbound messages API
- Inbound sms API
- Invitations API
- Job runs API
- Jobs API
- Knowledge schemas API
- KV API
- KV namespaces API
- Lease events API
- Leases API
- Licence keys API
- Licence tokens API
- Mail domains API
- Mail routes API
- Mailbox connect links API
- Mailbox OAUTH apps API
- Mailboxes API
- Memberships API
- Memories API
- Memory stores API
- Merchant accounts API
- Message topics API
- Messages API
- OAUTH clients API
- Objects API
- Organization roles API
- Owner pools API
- Phone numbers API
- Portal sessions API
- Preferences API
- Price catalogs API
- Processor events API
- Projects API
- Queued executions API
- Queues API
- Realtime channels API
- Realtime members API
- Realtime messages API
- Recipients API
- Relations API
- Releases API
- Revenue API
- Revenue facts API
- Revenue sources API
- Runs API
- Sandbox shapes API
- Schedules API
- Scrubbing policies API
- Search API
- Search indexes API
- Secret versions API
- Secrets API
- Service enablements API
- Service observations API
- Services API
- Serving routes API
- Session events API
- Sessions API
- Signing key versions
- Signing keys
- Sms numbers API
- Source maps API
- Spaces API
- Store connections API
- Store purchases API
- Subscriptions API
- Suppressions API
- Tax threshold statuses API
- Templates API
- Test clocks API
- Token exchanges API
- Transfers API
- Trust policies API
- Trusted issuers API
- Uptime checks API
- Uptime manifests API
- Uptime sources API
- Usage events API
- Usage invoices API
- Usage meter prices API
- Usage meters API
- Usage reservations API
- Usage settings API
- Usage tiers API
- Volumes API
- Waits API
- Webhook deliveries API
- Webhook endpoints API
- Workflows API
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get an inbound message
Get one message in the unified SMS and voice inbox.
Get one message in the unified SMS and voice inbox.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number/inbound_messages/inbound-message - Scope
notify:read - Effect
read— nothing is written. - Collection inbound_messages
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The message resource. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}/inbound_messages/{inbound_message}. |
uid | string | Stable identifier; existing SMS identifiers are preserved. Output only. |
meta | ResourceMeta | Resource metadata. |
sequence | int64 | The feed position, advancing when content changes 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 | SMS text or the completed voicemail transcript. Empty after retention. Output only. |
segments | int32 | SMS segments; not applicable to voice. 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. |
channel | string | sms or voice. Output only. |
voice | VoiceMessage | Call and recording metadata; present only for voice. Output only. |
expire_time | timestamp | Deadline for recording and transcript deletion. 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. |
#VoiceMessage
| Field | Type | What it is |
|---|---|---|
call_session_id | string | Stable carrier call-session identifier. Output only. |
state | string | missed or recorded. A saved recording never regresses to missed. Output only. |
recording_key | string | Tenant-scoped Storage key. Read bytes through DownloadInboundMessage. Output only. |
recording_duration | duration | Duration of saved audio, preserving carrier-reported milliseconds. Output only. |
transcription_status | string | pending, completed or failed. Completed transcripts do not regress. Output only. |
recording_error | bool | Recording failed; call metadata remains available. Output only. |
hangup_time | timestamp | Carrier-reported hangup time, if received. Output only. |
hangup_cause | string | Carrier-reported hangup cause, if received. 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_messages/inbound-message" \
-H "Authorization: Bearer $SYLPHX_API_KEY"