SmsSendOptions
Defined in: packages/core/src/types/message.ts:182
Extends
Section titled “Extends”Properties
Section titled “Properties”
optionalfrom:string
Defined in: packages/core/src/types/message.ts:75
Sender number / sender id. Optional at KMsg layer; providers may require it.
Inherited from
Section titled “Inherited from”imageUrl?
Section titled “imageUrl?”
optionalimageUrl:string
Defined in: packages/core/src/types/message.ts:197
Optional image URL for MMS (provider-specific).
media?
Section titled “media?”
optionalmedia:MessageMedia
Defined in: packages/core/src/types/message.ts:193
Media attachments. For backwards compatibility, imageUrl is treated as a legacy alias
for media.image.ref by some providers.
messageId?
Section titled “messageId?”
optionalmessageId:string
Defined in: packages/core/src/types/message.ts:66
Correlation id generated by KMsg (or provided by the caller). Providers must echo this value back in SendResult.messageId.
Inherited from
Section titled “Inherited from”options?
Section titled “options?”
optionaloptions:object
Defined in: packages/core/src/types/message.ts:79
Common delivery options understood by multiple providers.
country?
Section titled “country?”
optionalcountry:string
Country code for providers that support it (e.g. SOLAPI). Examples: “82”, “+82”.
customFields?
Section titled “customFields?”
optionalcustomFields:Record<string,string>
scheduledAt?
Section titled “scheduledAt?”
optionalscheduledAt:Date
Inherited from
Section titled “Inherited from”providerId?
Section titled “providerId?”
optionalproviderId:string
Defined in: packages/core/src/types/message.ts:70
Optional routing hint to force a specific provider by id.
Inherited from
Section titled “Inherited from”providerOptions?
Section titled “providerOptions?”
optionalproviderOptions:Record<string,unknown>
Defined in: packages/core/src/types/message.ts:91
Provider-specific escape hatch (use sparingly).
Inherited from
Section titled “Inherited from”CommonSendOptions.providerOptions
subject?
Section titled “subject?”
optionalsubject:string
Defined in: packages/core/src/types/message.ts:188
LMS/MMS subject.
text:
string
Defined in: packages/core/src/types/message.ts:184
to:
string
Defined in: packages/core/src/types/message.ts:71
Inherited from
Section titled “Inherited from”type:
"SMS"|"LMS"|"MMS"
Defined in: packages/core/src/types/message.ts:183
variables?
Section titled “variables?”
optionalvariables:MessageVariables
Defined in: packages/core/src/types/message.ts:198