AligoProvider
Defined in: packages/provider/src/aligo/provider.ts:22
Aligo Provider package entrypoint
Extends
Section titled “Extends”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AligoProvider(
config):AligoProvider
Defined in: packages/provider/src/aligo/provider.send.ts:60
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”AligoProvider
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”
readonlyid:"aligo"="aligo"
Defined in: packages/provider/src/aligo/provider.send.ts:38
Unique identifier for this provider instance. Used for routing and logging.
Example
Section titled “Example”"solapi"Inherited from
Section titled “Inherited from”
readonlyname:"Aligo Smart SMS"="Aligo Smart SMS"
Defined in: packages/provider/src/aligo/provider.send.ts:39
Human-readable name for display purposes.
Example
Section titled “Example”"SOLAPI"Inherited from
Section titled “Inherited from”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/aligo/provider.send.ts:40
Message types this provider supports. Messages of unsupported types will be rejected.
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addKakaoChannel()
Section titled “addKakaoChannel()”addKakaoChannel(
params):Promise<Result<KakaoChannel,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:150
Add a Kakao channel after authentication.
Parameters
Section titled “Parameters”params
Section titled “params”authNum
Section titled “authNum”string
categoryCode
Section titled “categoryCode”string
phoneNumber
Section titled “phoneNumber”string
plusId
Section titled “plusId”string
Returns
Section titled “Returns”Promise<Result<KakaoChannel, KMsgError>>
Inherited from
Section titled “Inherited from”createTemplate()
Section titled “createTemplate()”createTemplate(
input,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:26
Create a new template.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.createTemplate
deleteTemplate()
Section titled “deleteTemplate()”deleteTemplate(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:41
Delete a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.deleteTemplate
getOnboardingSpec()
Section titled “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
Section titled “Returns”Inherited from
Section titled “Inherited from”AligoProvider.getOnboardingSpec
getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:48
Get a template by code.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>
Implementation of
Section titled “Implementation of”healthCheck()
Section titled “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
Section titled “Returns”Promise<ProviderHealthStatus>
Inherited from
Section titled “Inherited from”listKakaoChannelCategories()
Section titled “listKakaoChannelCategories()”listKakaoChannelCategories():
Promise<Result<KakaoChannelCategories,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:137
List available channel categories for registration.
Returns
Section titled “Returns”Promise<Result<KakaoChannelCategories, KMsgError>>
Inherited from
Section titled “Inherited from”AligoProvider.listKakaoChannelCategories
listKakaoChannels()
Section titled “listKakaoChannels()”listKakaoChannels(
params?):Promise<Result<KakaoChannel[],KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:130
List registered Kakao channels.
Parameters
Section titled “Parameters”params?
Section titled “params?”plusId?
Section titled “plusId?”string
senderKey?
Section titled “senderKey?”string
Returns
Section titled “Returns”Promise<Result<KakaoChannel[], KMsgError>>
Inherited from
Section titled “Inherited from”AligoProvider.listKakaoChannels
listTemplates()
Section titled “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
Section titled “Parameters”params?
Section titled “params?”limit?
Section titled “limit?”number
number
status?
Section titled “status?”string
Returns
Section titled “Returns”Promise<Result<Template[], KMsgError>>
Implementation of
Section titled “Implementation of”TemplateProvider.listTemplates
requestKakaoChannelAuth()
Section titled “requestKakaoChannelAuth()”requestKakaoChannelAuth(
params):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:143
Request authentication SMS for channel registration.
Parameters
Section titled “Parameters”params
Section titled “params”phoneNumber
Section titled “phoneNumber”string
plusId
Section titled “plusId”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Inherited from
Section titled “Inherited from”AligoProvider.requestKakaoChannelAuth
requestTemplateInspection()
Section titled “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
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<void, KMsgError>>
Implementation of
Section titled “Implementation of”TemplateInspectionProvider.requestTemplateInspection
send()
Section titled “send()”send(
options):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:124
Send a message through this provider.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.
Inherited from
Section titled “Inherited from”updateTemplate()
Section titled “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
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>