AligoProvider
Defined in: packages/provider/src/aligo/provider.send.ts:39
Aligo send/channel focused entrypoint.
Extended by
섹션 제목: “Extended by”Implements
섹션 제목: “Implements”Constructors
섹션 제목: “Constructors”Constructor
섹션 제목: “Constructor”new AligoProvider(
config):AligoSendProvider
Defined in: packages/provider/src/aligo/provider.send.ts:66
Parameters
섹션 제목: “Parameters”config
섹션 제목: “config”Returns
섹션 제목: “Returns”AligoSendProvider
Properties
섹션 제목: “Properties”
readonlyid:"aligo"="aligo"
Defined in: packages/provider/src/aligo/provider.send.ts:40
Unique identifier for this provider instance. Used for routing and logging.
Example
섹션 제목: “Example”"solapi"Implementation of
섹션 제목: “Implementation of”name
섹션 제목: “name”
readonlyname:"Aligo Smart SMS"="Aligo Smart SMS"
Defined in: packages/provider/src/aligo/provider.send.ts:41
Human-readable name for display purposes.
Example
섹션 제목: “Example”"SOLAPI"Implementation of
섹션 제목: “Implementation of”supportedTypes
섹션 제목: “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/aligo/provider.send.ts:42
Message types this provider supports. Messages of unsupported types will be rejected.
Implementation of
섹션 제목: “Implementation of”transportCapabilities
섹션 제목: “transportCapabilities”
readonlytransportCapabilities:object
Defined in: packages/provider/src/aligo/provider.send.ts:49
Per-operation transport features supported by this provider. Missing declarations must be treated as unsupported.
abortSignal
섹션 제목: “abortSignal”
readonlyabortSignal:"supported"="supported"
injectableFetch
섹션 제목: “injectableFetch”
readonlyinjectableFetch:"supported"="supported"
Implementation of
섹션 제목: “Implementation of”Provider.transportCapabilities
Methods
섹션 제목: “Methods”addKakaoChannel()
섹션 제목: “addKakaoChannel()”addKakaoChannel(
params):Promise<Result<KakaoChannel,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:162
Add a Kakao channel after authentication.
Parameters
섹션 제목: “Parameters”params
섹션 제목: “params”authNum
섹션 제목: “authNum”string
categoryCode
섹션 제목: “categoryCode”string
phoneNumber
섹션 제목: “phoneNumber”string
plusId
섹션 제목: “plusId”string
Returns
섹션 제목: “Returns”Promise<Result<KakaoChannel, KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.addKakaoChannel
getOnboardingSpec()
섹션 제목: “getOnboardingSpec()”getOnboardingSpec():
ProviderOnboardingSpec
Defined in: packages/provider/src/aligo/provider.send.ts:58
Get the onboarding specification for this provider. Used by tooling to guide provider configuration.
Returns
섹션 제목: “Returns”Implementation of
섹션 제목: “Implementation of”healthCheck()
섹션 제목: “healthCheck()”healthCheck():
Promise<ProviderHealthStatus>
Defined in: packages/provider/src/aligo/provider.send.ts:94
Check if the provider is operational. Used for health monitoring and circuit breaker decisions.
Returns
섹션 제목: “Returns”Promise<ProviderHealthStatus>
Implementation of
섹션 제목: “Implementation of”listKakaoChannelCategories()
섹션 제목: “listKakaoChannelCategories()”listKakaoChannelCategories():
Promise<Result<KakaoChannelCategories,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:149
List available channel categories for registration.
Returns
섹션 제목: “Returns”Promise<Result<KakaoChannelCategories, KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.listKakaoChannelCategories
listKakaoChannels()
섹션 제목: “listKakaoChannels()”listKakaoChannels(
params?):Promise<Result<KakaoChannel[],KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:142
List registered Kakao channels.
Parameters
섹션 제목: “Parameters”params?
섹션 제목: “params?”plusId?
섹션 제목: “plusId?”string
senderKey?
섹션 제목: “senderKey?”string
Returns
섹션 제목: “Returns”Promise<Result<KakaoChannel[], KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.listKakaoChannels
requestKakaoChannelAuth()
섹션 제목: “requestKakaoChannelAuth()”requestKakaoChannelAuth(
params):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:155
Request authentication SMS for channel registration.
Parameters
섹션 제목: “Parameters”params
섹션 제목: “params”phoneNumber
섹션 제목: “phoneNumber”string
plusId
섹션 제목: “plusId”string
Returns
섹션 제목: “Returns”Promise<Result<void, KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.requestKakaoChannelAuth
send()
섹션 제목: “send()”send(
options,context?):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/aligo/provider.send.ts:133
Send a message through this provider.
Parameters
섹션 제목: “Parameters”options
섹션 제목: “options”context?
섹션 제목: “context?”Returns
섹션 제목: “Returns”Promise<Result<SendResult, KMsgError>>
Result with SendResult on success, KMsgError on failure.