Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / smsPlaceholderSpec

Variable: smsPlaceholderSpec

const smsPlaceholderSpec: PlaceholderSpec

Defined in: rcml/src/sms/sms-placeholder-spec.ts:59

Machine-readable placeholder spec for SMS — a filtered view of placeholderSpec containing only the six token types valid in SMS messages. Excluded: LoopValue, RandomString, Dispatcher, PromoCode.

Example ​

ts
import { smsPlaceholderSpec } from '@rule/rcml'

// All SMS-valid token type names
Object.keys(smsPlaceholderSpec.tokens)
// → ['CustomField', 'Subscriber', 'User', 'Date', 'RemoteContent', 'Link']

// System link types that can appear in href or as Link placeholders
smsPlaceholderSpec.tokens['Link'].params?.['type'].allowedValues
// → ['Optin', 'Unsubscribe', 'WebBrowser', 'ShareLink', 'Signup']

// Cross-reference with smsRfmSpec:
import { smsRfmSpec } from '@rule/rcml'
smsRfmSpec.nodes['placeholder'].attrs?.['type'].allowedValues
// → same list as Object.keys(smsPlaceholderSpec.tokens)