AligoProvider
Defined in: packages/provider/src/aligo/provider.send.ts:37
Aligo send/channel focused entrypoint.
Extended by
Section titled “Extended by”Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AligoProvider(
config):AligoSendProvider
Defined in: packages/provider/src/aligo/provider.send.ts:60
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”AligoSendProvider
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"Implementation of
Section titled “Implementation of”
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"Implementation of
Section titled “Implementation of”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.
Implementation of
Section titled “Implementation of”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>>
Implementation of
Section titled “Implementation of”KakaoChannelProvider.addKakaoChannel
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”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>
Implementation of
Section titled “Implementation of”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>>
Implementation of
Section titled “Implementation of”KakaoChannelProvider.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>>
Implementation of
Section titled “Implementation of”KakaoChannelProvider.listKakaoChannels
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>>
Implementation of
Section titled “Implementation of”KakaoChannelProvider.requestKakaoChannelAuth
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.