Class KakaoAlimtalkManagementClient

카카오 알림톡 관리 클라이언트

카카오 알림톡 대체발송 설정 기능을 제공합니다. SMS AppKey 등록 및 대체발송 설정을 지원합니다.

Example

const kakaoAlimtalkManagementClient = new KakaoAlimtalkManagementClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});

// SMS AppKey 등록
await kakaoAlimtalkManagementClient.registerAlimtalkFailbackAppKey("my-client-1", {
  resendAppKey: "SMS_APP_KEY_123"
});

// 대체발송 설정 등록
await kakaoAlimtalkManagementClient.registerAlimtalkFailbackSetting("my-client-1", {
  senderKey: "SENDER_KEY_123",
  resendSendNo: "15881234"
});

Index

Constructors

constructor

new KakaoAlimtalkManagementClient(
credentials: AwesomeMessageCredentials,
): KakaoAlimtalkManagementClient
카카오 알림톡 관리 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoAlimtalkManagementClient
Example
```
const client = new KakaoAlimtalkManagementClient({
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key'
});
```
Overrides BaseClient.constructor

Methods

`Protected`createSendHeaders

createSendHeaders(options?: SendOptions): Record<string, string>
SendOptions에서 HTTP 헤더를 생성합니다
Parameters
- Optionaloptions: SendOptions
  발송 옵션
Returns Record<string, string>
생성된 헤더 객체

Inherited from BaseClient.createSendHeaders

`Protected`get

get<T>(path: string, headers?: Record<string, string>): Promise<T>
GET 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.get

`Protected`post

post<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
POST 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.post

`Protected`postFormData

postFormData<T>(
    path: string,
    formData: FormData,
    headers?: Record<string, string>,
): Promise<T>
FormData를 사용한 POST 요청 (multipart/form-data)
Type Parameters
- T
Parameters
- path: string
  API 경로
- formData: FormData
  undici의 FormData 객체
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.postFormData

`Protected`put

put<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
PUT 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.put

`Protected`delete

delete<T>(path: string, headers?: Record<string, string>): Promise<T>
DELETE 요청
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.delete

`Protected`deleteWithBody

deleteWithBody<T>(
    path: string,
    body?: unknown,
    headers?: Record<string, string>,
): Promise<T>
DELETE 요청 (body 포함)
Type Parameters
- T
Parameters
- path: string
  API 경로
- Optionalbody: unknown
  요청 본문
- Optionalheaders: Record<string, string>
  추가 헤더
Returns Promise<T>
응답 데이터

Inherited from BaseClient.deleteWithBody

registerAlimtalkFailbackAppKey

registerAlimtalkFailbackAppKey(
externalId: string,
request: RegisterAlimtalkFailbackAppKeyRequest,
): Promise<void>
알림톡 대체발송용 SMS AppKey를 등록합니다.

알림톡 발송 실패 시 대체발송에 사용할 SMS 상품의 AppKey를 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: RegisterAlimtalkFailbackAppKeyRequest
  AppKey 등록 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.registerAlimtalkFailbackAppKey("my-client-1", {
  resendAppKey: "SMS_APP_KEY_123"
});
```

registerAlimtalkFailbackSetting

registerAlimtalkFailbackSetting(
externalId: string,
request: RegisterAlimtalkFailbackSettingRequest,
): Promise<void>
알림톡 대체발송 설정을 등록합니다.

대체발송 설정을 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: RegisterAlimtalkFailbackSettingRequest
  대체발송 설정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.registerAlimtalkFailbackSetting("my-client-1", {
  senderKey: "SENDER_KEY_123",
  resendSendNo: "15881234"
});
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoAlimtalkManagementClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoAlimtalkManagementClient

Example

Methods

ProtectedcreateSendHeaders

Parameters

Returns Record<string, string>

Protectedget

Type Parameters

Parameters

Returns Promise<T>

Protectedpost

Type Parameters

Parameters

Returns Promise<T>

ProtectedpostFormData

Type Parameters

Parameters

Returns Promise<T>

Protectedput

Type Parameters

Parameters

Returns Promise<T>

Protecteddelete

Type Parameters

Parameters

Returns Promise<T>

ProtecteddeleteWithBody

Type Parameters

Parameters

Returns Promise<T>

registerAlimtalkFailbackAppKey

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

registerAlimtalkFailbackSetting

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

Properties

Protectedcredentials

Settings

On This Page

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials