Provider

Defined in: packages/core/src/provider.ts:206

Core provider interface for sending messages.

All providers must implement this interface. Optional capabilities (balance, templates, delivery status) are exposed via separate interfaces.

Example

class MyProvider implements Provider {
  readonly id = "my-provider";
  readonly name = "My Provider";
  readonly supportedTypes = ["SMS", "LMS"] as const;

  async healthCheck() { return { healthy: true, issues: [] }; }
  async send(params) { ... }
}

Properties

id

readonly id: string

Defined in: packages/core/src/provider.ts:212

Unique identifier for this provider instance. Used for routing and logging.

Example

"solapi"

---

name

readonly name: string

Defined in: packages/core/src/provider.ts:217

Human-readable name for display purposes.

Example

"SOLAPI"

---

supportedTypes

readonly supportedTypes: readonly MessageType[]

Defined in: packages/core/src/provider.ts:222

Message types this provider supports. Messages of unsupported types will be rejected.

Methods

getDeliveryStatus()?

optional getDeliveryStatus(query): Promise<Result<DeliveryStatusResult | null, KMsgError>>

Defined in: packages/core/src/provider.ts:238

Query delivery status for a previously sent message. Optional capability - not all providers support this.

Parameters

query

DeliveryStatusQuery

Returns

Promise<Result<DeliveryStatusResult | null, KMsgError>>

---

getOnboardingSpec()?

optional getOnboardingSpec(): ProviderOnboardingSpec

Defined in: packages/core/src/provider.ts:245

Get the onboarding specification for this provider. Used by tooling to guide provider configuration.

Returns

ProviderOnboardingSpec

---

healthCheck()

healthCheck(): Promise<ProviderHealthStatus>

Defined in: packages/core/src/provider.ts:228

Check if the provider is operational. Used for health monitoring and circuit breaker decisions.

Returns

Promise<ProviderHealthStatus>

---

send()

send(params): Promise<Result<SendResult, KMsgError>>

Defined in: packages/core/src/provider.ts:233

Send a message through this provider.

Parameters

params

SendOptions

Returns

Promise<Result<SendResult, KMsgError>>

Result with SendResult on success, KMsgError on failure.