FaxMessageSendOptions

Defined in: packages/core/src/types/message.ts:233

Extends

• CommonSendOptions

Properties

fax

fax: FaxSendOptions

Defined in: packages/core/src/types/message.ts:235

---

from?

optional from: string

Defined in: packages/core/src/types/message.ts:75

Sender number / sender id. Optional at KMsg layer; providers may require it.

Inherited from

CommonSendOptions.from

---

messageId?

optional messageId: 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

CommonSendOptions.messageId

---

options?

optional options: object

Defined in: packages/core/src/types/message.ts:79

Common delivery options understood by multiple providers.

country?

optional country: string

Country code for providers that support it (e.g. SOLAPI). Examples: “82”, “+82”.

customFields?

optional customFields: Record<string, string>

scheduledAt?

optional scheduledAt: Date

Inherited from

CommonSendOptions.options

---

providerId?

optional providerId: string

Defined in: packages/core/src/types/message.ts:70

Optional routing hint to force a specific provider by id.

Inherited from

CommonSendOptions.providerId

---

providerOptions?

optional providerOptions: Record<string, unknown>

Defined in: packages/core/src/types/message.ts:91

Provider-specific escape hatch (use sparingly).

Inherited from

CommonSendOptions.providerOptions

---

to

to: string

Defined in: packages/core/src/types/message.ts:71

Inherited from

CommonSendOptions.to

---

type

type: "FAX"

Defined in: packages/core/src/types/message.ts:234