Skip to content
Console
Menu

Getting Started

Authentication

KV Store

List inbound sms

Lists a number's inbound SMS in feed order, oldest first.

Lists a number's inbound SMS in feed order, oldest first.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number/inbound_sms
  • Scope notify:read
  • Effect read — nothing is written.
  • Collection inbound_sms
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries inbound_sms and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe number binding to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over filterable fields.
order_bystringAIP-132 ordering over filterable fields.

#Response

FieldTypeWhat it is
inbound_smsInboundSms[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

#InboundSms

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}/inbound_sms/{inbound_sms}.
uidstringisms_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
sequenceint64The feed position, increasing within the environment; filter sequence > N to resume after the last one handled. Output only.
carrier_message_idstringThe carrier's id for this message; the dedupe key on the number binding. Output only.
sender_numberstringThe sender, in E.164 when the carrier gave one. Output only.
recipient_numberstringThe number the message was sent to, in E.164. Output only.
textstringThe text. Empty once retention has cleared it. Output only.
segmentsint32How many segments the carrier counted. Output only.
receive_timetimestampWhen the carrier says it received the message. Output only.
clearedboolThe text has been cleared by retention; the dedupe key stays. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"