KakaoSenderNumberManager
Defined in: packages/channel/src/kakao/sender-number.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KakaoSenderNumberManager():
KakaoSenderNumberManager
Returns
Section titled “Returns”KakaoSenderNumberManager
Methods
Section titled “Methods”addSenderNumber()
Section titled “addSenderNumber()”addSenderNumber(
channelId,request):Promise<SenderNumber>
Defined in: packages/channel/src/kakao/sender-number.ts:13
Parameters
Section titled “Parameters”channelId
Section titled “channelId”string
request
Section titled “request”Returns
Section titled “Returns”Promise<SenderNumber>
blockSenderNumber()
Section titled “blockSenderNumber()”blockSenderNumber(
senderNumberId,reason):Promise<void>
Defined in: packages/channel/src/kakao/sender-number.ts:253
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
reason
Section titled “reason”string
Returns
Section titled “Returns”Promise<void>
cleanup()
Section titled “cleanup()”cleanup():
void
Defined in: packages/channel/src/kakao/sender-number.ts:331
Returns
Section titled “Returns”void
deleteSenderNumber()
Section titled “deleteSenderNumber()”deleteSenderNumber(
senderNumberId):Promise<boolean>
Defined in: packages/channel/src/kakao/sender-number.ts:231
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
Returns
Section titled “Returns”Promise<boolean>
getSenderNumber()
Section titled “getSenderNumber()”getSenderNumber(
senderNumberId):Promise<SenderNumber|null>
Defined in: packages/channel/src/kakao/sender-number.ts:166
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
Returns
Section titled “Returns”Promise<SenderNumber | null>
listSenderNumbers()
Section titled “listSenderNumbers()”listSenderNumbers(
filters?):Promise<SenderNumber[]>
Defined in: packages/channel/src/kakao/sender-number.ts:170
Parameters
Section titled “Parameters”filters?
Section titled “filters?”category?
Section titled “category?”channelId?
Section titled “channelId?”string
status?
Section titled “status?”verified?
Section titled “verified?”boolean
Returns
Section titled “Returns”Promise<SenderNumber[]>
resendVerificationCode()
Section titled “resendVerificationCode()”resendVerificationCode(
senderNumberId):Promise<void>
Defined in: packages/channel/src/kakao/sender-number.ts:139
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
Returns
Section titled “Returns”Promise<void>
unblockSenderNumber()
Section titled “unblockSenderNumber()”unblockSenderNumber(
senderNumberId):Promise<void>
Defined in: packages/channel/src/kakao/sender-number.ts:269
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
Returns
Section titled “Returns”Promise<void>
updateSenderNumber()
Section titled “updateSenderNumber()”updateSenderNumber(
senderNumberId,updates):Promise<SenderNumber>
Defined in: packages/channel/src/kakao/sender-number.ts:210
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
updates
Section titled “updates”Partial<SenderNumber>
Returns
Section titled “Returns”Promise<SenderNumber>
validateSenderNumberForSending()
Section titled “validateSenderNumberForSending()”validateSenderNumberForSending(
senderNumberId):Promise<{errors:string[];isValid:boolean; }>
Defined in: packages/channel/src/kakao/sender-number.ts:286
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
Returns
Section titled “Returns”Promise<{ errors: string[]; isValid: boolean; }>
verifySenderNumber()
Section titled “verifySenderNumber()”verifySenderNumber(
senderNumberId,code):Promise<boolean>
Defined in: packages/channel/src/kakao/sender-number.ts:103
Parameters
Section titled “Parameters”senderNumberId
Section titled “senderNumberId”string
string
Returns
Section titled “Returns”Promise<boolean>