Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / rcml/src / SmsDocument

Interface: SmsDocument

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

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

Pass this type wherever the API accepts an SMS template body. Construct one with createSmsDocument.

Properties ​

content ​

content: SmsContentJson

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

SMS message body as structured content JSON.

id? ​

optional id?: string

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

Document identifier (UUID). Generated automatically by createSmsDocument and the XML parser. Required by validateSmsDocument — a missing or malformed value yields ID_INVALID. Always construct documents with createSmsDocument, which fills in a valid UUID. Client methods also auto-inject a UUID before sending, so a hand-assembled document without an id will pass the API but will fail local validation until one is added.

tagName ​

tagName: "rc-sms"

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