Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Inbound sms

An Inbound SMS is one text a bound number received, kept as evidence.

An Inbound SMS is one text a bound number received, kept as evidence. The body is cleared when the environment's tier retention expires; the carrier's message id stays, so a replay after that never records the message again. Consumers read the feed in sequence order.

Service Sylphx Notify · Resource type notify.sylphx.com/InboundSms · Name pattern orgs/{org}/projects/{project}/envs/{env}/sms_numbers/{sms_number}/inbound_sms/{inbound_sms} · Shape record

#Fields

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.

#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
GETgetGets one inbound SMS.
GETlistLists a number's inbound SMS in feed order, oldest first.

#get

Gets one inbound SMS.

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 · Request, response and examples

#list

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

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/sms_numbers/sms-number/inbound_sms · scope notify:read · effect read · paginated · Request, response and examples