Skip to content

Rule.io SDK


Rule.io SDK / rcml/src / SmsDocument

Interface: SmsDocument

Defined in: rcml/src/sms/sms-types.ts:32

Root (and only) node of an SMS RCML document.

Conforms to the RcmlAstLeafNode shape used by the Rule.io SMS editor. Pass this type wherever the API accepts an SMS template body. Construct one with createSmsDocument.

Properties

attributes

attributes: Record<string, never>

Defined in: rcml/src/sms/sms-types.ts:37

Always empty — the rc-sms node declares no attributes.


content

content: SmsContentJson

Defined in: rcml/src/sms/sms-types.ts:39

SMS message body as structured content JSON.


id?

optional id?: string

Defined in: rcml/src/sms/sms-types.ts:34

Optional node ID (UUID).


tagName

tagName: "rc-sms"

Defined in: rcml/src/sms/sms-types.ts:35