AligoProvider

Defined in: packages/provider/src/aligo/provider.ts:22

Aligo Provider package entrypoint

Extends

• AligoProvider

Implements

• TemplateProvider
• TemplateInspectionProvider

Constructors

Constructor

new AligoProvider(config): AligoProvider

Defined in: packages/provider/src/aligo/provider.send.ts:60

Parameters

config

AligoConfig

Returns

AligoProvider

Inherited from

AligoProvider.constructor

Properties

id

readonly id: "aligo" = "aligo"

Defined in: packages/provider/src/aligo/provider.send.ts:38

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

Example

"solapi"

Inherited from

AligoProvider.id

---

name

readonly name: "Aligo Smart SMS" = "Aligo Smart SMS"

Defined in: packages/provider/src/aligo/provider.send.ts:39

Human-readable name for display purposes.

Example

"SOLAPI"

Inherited from

AligoProvider.name

---

supportedTypes

readonly supportedTypes: readonly MessageType[]

Defined in: packages/provider/src/aligo/provider.send.ts:40

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

Inherited from

AligoProvider.supportedTypes

Methods

addKakaoChannel()

addKakaoChannel(params): Promise<Result<KakaoChannel, KMsgError>>

Defined in: packages/provider/src/aligo/provider.send.ts:150

Add a Kakao channel after authentication.

Parameters

params

authNum

string

categoryCode

string

phoneNumber

string

plusId

string

Returns

Promise<Result<KakaoChannel, KMsgError>>

Inherited from

AligoProvider.addKakaoChannel

---

createTemplate()

createTemplate(input, ctx?): Promise<Result<Template, KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:26

Create a new template.

Parameters

input

TemplateCreateInput

ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.createTemplate

---

deleteTemplate()

deleteTemplate(code, ctx?): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:41

Delete a template by code.

Parameters

code

string

ctx?

TemplateContext

Returns

Promise<Result<void, KMsgError>>

Implementation of

TemplateProvider.deleteTemplate

---

getOnboardingSpec()

getOnboardingSpec(): ProviderOnboardingSpec

Defined in: packages/provider/src/aligo/provider.send.ts:52

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

Returns

ProviderOnboardingSpec

Inherited from

AligoProvider.getOnboardingSpec

---

getTemplate()

getTemplate(code, ctx?): Promise<Result<Template, KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:48

Get a template by code.

Parameters

code

string

ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.getTemplate

---

healthCheck()

healthCheck(): Promise<ProviderHealthStatus>

Defined in: packages/provider/src/aligo/provider.send.ts:85

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

Returns

Promise<ProviderHealthStatus>

Inherited from

AligoProvider.healthCheck

---

listKakaoChannelCategories()

listKakaoChannelCategories(): Promise<Result<KakaoChannelCategories, KMsgError>>

Defined in: packages/provider/src/aligo/provider.send.ts:137

List available channel categories for registration.

Returns

Promise<Result<KakaoChannelCategories, KMsgError>>

Inherited from

AligoProvider.listKakaoChannelCategories

---

listKakaoChannels()

listKakaoChannels(params?): Promise<Result<KakaoChannel[], KMsgError>>

Defined in: packages/provider/src/aligo/provider.send.ts:130

List registered Kakao channels.

Parameters

params?

plusId?

string

senderKey?

string

Returns

Promise<Result<KakaoChannel[], KMsgError>>

Inherited from

AligoProvider.listKakaoChannels

---

listTemplates()

listTemplates(params?, ctx?): Promise<Result<Template[], KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:55

List templates with optional filtering and pagination.

Parameters

params?

limit?

number

page?

number

status?

string

ctx?

TemplateContext

Returns

Promise<Result<Template[], KMsgError>>

Implementation of

TemplateProvider.listTemplates

---

requestKakaoChannelAuth()

requestKakaoChannelAuth(params): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/aligo/provider.send.ts:143

Request authentication SMS for channel registration.

Parameters

params

phoneNumber

string

plusId

string

Returns

Promise<Result<void, KMsgError>>

Inherited from

AligoProvider.requestKakaoChannelAuth

---

requestTemplateInspection()

requestTemplateInspection(code, ctx?): Promise<Result<void, KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:62

Request inspection for a template (submits for approval review).

Parameters

code

string

ctx?

TemplateContext

Returns

Promise<Result<void, KMsgError>>

Implementation of

TemplateInspectionProvider.requestTemplateInspection

---

send()

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

Defined in: packages/provider/src/aligo/provider.send.ts:124

Send a message through this provider.

Parameters

options

SendOptions

Returns

Promise<Result<SendResult, KMsgError>>

Result with SendResult on success, KMsgError on failure.

Inherited from

AligoProvider.send

---

updateTemplate()

updateTemplate(code, patch, ctx?): Promise<Result<Template, KMsgError>>

Defined in: packages/provider/src/aligo/provider.ts:33

Update an existing template by code.

Parameters

code

string

patch

TemplateUpdateInput

ctx?

TemplateContext

Returns

Promise<Result<Template, KMsgError>>

Implementation of

TemplateProvider.updateTemplate