AligoProvider
Defined in: packages/provider/src/aligo/provider.ts:39
Aligo Provider package entrypoint
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AligoProvider(
config):AligoProvider
Defined in: packages/provider/src/aligo/provider.ts:67
Parameters
Section titled “Parameters”config
Section titled “config”Returns
Section titled “Returns”AligoProvider
Properties
Section titled “Properties”
readonlyid:"aligo"="aligo"
Defined in: packages/provider/src/aligo/provider.ts:46
Implementation of
Section titled “Implementation of”
readonlyname:"Aligo Smart SMS"="Aligo Smart SMS"
Defined in: packages/provider/src/aligo/provider.ts:47
Implementation of
Section titled “Implementation of”supportedTypes
Section titled “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/aligo/provider.ts:48
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.ts:156
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
createTemplate()
Section titled “createTemplate()”createTemplate(
input,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:165
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:180
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.ts:59
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”getTemplate()
Section titled “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:187
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.ts:91
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.ts:143
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.ts:136
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
listTemplates()
Section titled “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:194
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.ts:149
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
requestTemplateInspection()
Section titled “requestTemplateInspection()”requestTemplateInspection(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:201
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.ts:130
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<Result<SendResult, KMsgError>>
Implementation of
Section titled “Implementation of”updateTemplate()
Section titled “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:172
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<Template, KMsgError>>