AligoProvider
Defined in: packages/provider/src/aligo/provider.ts:39
Aligo Provider package entrypoint
Implements
섹션 제목: “Implements”Constructors
섹션 제목: “Constructors”Constructor
섹션 제목: “Constructor”new AligoProvider(
config):AligoProvider
Defined in: packages/provider/src/aligo/provider.ts:67
Parameters
섹션 제목: “Parameters”config
섹션 제목: “config”Returns
섹션 제목: “Returns”AligoProvider
Properties
섹션 제목: “Properties”
readonlyid:"aligo"="aligo"
Defined in: packages/provider/src/aligo/provider.ts:46
Implementation of
섹션 제목: “Implementation of”name
섹션 제목: “name”
readonlyname:"Aligo Smart SMS"="Aligo Smart SMS"
Defined in: packages/provider/src/aligo/provider.ts:47
Implementation of
섹션 제목: “Implementation of”supportedTypes
섹션 제목: “supportedTypes”
readonlysupportedTypes: readonlyMessageType[]
Defined in: packages/provider/src/aligo/provider.ts:48
Implementation of
섹션 제목: “Implementation of”Methods
섹션 제목: “Methods”addKakaoChannel()
섹션 제목: “addKakaoChannel()”addKakaoChannel(
params):Promise<Result<KakaoChannel,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:156
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
createTemplate()
섹션 제목: “createTemplate()”createTemplate(
input,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:165
Parameters
섹션 제목: “Parameters”input
섹션 제목: “input”ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<Template, KMsgError>>
Implementation of
섹션 제목: “Implementation of”TemplateProvider.createTemplate
deleteTemplate()
섹션 제목: “deleteTemplate()”deleteTemplate(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:180
Parameters
섹션 제목: “Parameters”code
섹션 제목: “code”string
ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<void, KMsgError>>
Implementation of
섹션 제목: “Implementation of”TemplateProvider.deleteTemplate
getOnboardingSpec()
섹션 제목: “getOnboardingSpec()”getOnboardingSpec():
ProviderOnboardingSpec
Defined in: packages/provider/src/aligo/provider.ts:59
Returns
섹션 제목: “Returns”Implementation of
섹션 제목: “Implementation of”getTemplate()
섹션 제목: “getTemplate()”getTemplate(
code,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:187
Parameters
섹션 제목: “Parameters”code
섹션 제목: “code”string
ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<Template, KMsgError>>
Implementation of
섹션 제목: “Implementation of”healthCheck()
섹션 제목: “healthCheck()”healthCheck():
Promise<ProviderHealthStatus>
Defined in: packages/provider/src/aligo/provider.ts:91
Returns
섹션 제목: “Returns”Promise<ProviderHealthStatus>
Implementation of
섹션 제목: “Implementation of”listKakaoChannelCategories()
섹션 제목: “listKakaoChannelCategories()”listKakaoChannelCategories():
Promise<Result<KakaoChannelCategories,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:143
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.ts:136
Parameters
섹션 제목: “Parameters”params?
섹션 제목: “params?”plusId?
섹션 제목: “plusId?”string
senderKey?
섹션 제목: “senderKey?”string
Returns
섹션 제목: “Returns”Promise<Result<KakaoChannel[], KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.listKakaoChannels
listTemplates()
섹션 제목: “listTemplates()”listTemplates(
params?,ctx?):Promise<Result<Template[],KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:194
Parameters
섹션 제목: “Parameters”params?
섹션 제목: “params?”limit?
섹션 제목: “limit?”number
page?
섹션 제목: “page?”number
status?
섹션 제목: “status?”string
ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<Template[], KMsgError>>
Implementation of
섹션 제목: “Implementation of”TemplateProvider.listTemplates
requestKakaoChannelAuth()
섹션 제목: “requestKakaoChannelAuth()”requestKakaoChannelAuth(
params):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:149
Parameters
섹션 제목: “Parameters”params
섹션 제목: “params”phoneNumber
섹션 제목: “phoneNumber”string
plusId
섹션 제목: “plusId”string
Returns
섹션 제목: “Returns”Promise<Result<void, KMsgError>>
Implementation of
섹션 제목: “Implementation of”KakaoChannelProvider.requestKakaoChannelAuth
requestTemplateInspection()
섹션 제목: “requestTemplateInspection()”requestTemplateInspection(
code,ctx?):Promise<Result<void,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:201
Parameters
섹션 제목: “Parameters”code
섹션 제목: “code”string
ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<void, KMsgError>>
Implementation of
섹션 제목: “Implementation of”TemplateInspectionProvider.requestTemplateInspection
send()
섹션 제목: “send()”send(
options):Promise<Result<SendResult,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:130
Parameters
섹션 제목: “Parameters”options
섹션 제목: “options”Returns
섹션 제목: “Returns”Promise<Result<SendResult, KMsgError>>
Implementation of
섹션 제목: “Implementation of”updateTemplate()
섹션 제목: “updateTemplate()”updateTemplate(
code,patch,ctx?):Promise<Result<Template,KMsgError>>
Defined in: packages/provider/src/aligo/provider.ts:172
Parameters
섹션 제목: “Parameters”code
섹션 제목: “code”string
patch
섹션 제목: “patch”ctx?
섹션 제목: “ctx?”Returns
섹션 제목: “Returns”Promise<Result<Template, KMsgError>>