Class KakaoAlimtalkTemplateClient

카카오 알림톡 템플릿 클라이언트

카카오 알림톡 템플릿 및 플러그인 관리 기능을 제공합니다. 템플릿 CRUD, 문의 관리, 플러그인 CRUD를 지원합니다.

Example

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

// 알림톡 템플릿 카테고리 조회
const categories = await kakaoAlimtalkTemplateClient.listAlimtalkTemplateCategories("my-client-1");

// 알림톡 템플릿 목록 조회
const templates = await kakaoAlimtalkTemplateClient.listAlimtalkTemplates("my-client-1", "SENDER_KEY_123");

Constructors

constructor

new KakaoAlimtalkTemplateClient(
credentials: AwesomeMessageCredentials,
): KakaoAlimtalkTemplateClient
카카오 알림톡 템플릿 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoAlimtalkTemplateClient
Example
```
const client = new KakaoAlimtalkTemplateClient({
  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

listAlimtalkTemplateCategories

listAlimtalkTemplateCategories(
externalId: string,
): Promise<ListAlimtalkTemplateCategoriesResponse>
알림톡 템플릿 카테고리 목록을 조회합니다.

템플릿 등록 시 사용할 수 있는 카테고리 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
Returns Promise<ListAlimtalkTemplateCategoriesResponse>
카테고리 목록
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const categories = await kakaoClient.listAlimtalkTemplateCategories("my-client-1");
// categories: { categories: [{ categoryCode: "001", categoryName: "일반", subCategories: [...] }] }
```

listAlimtalkTemplates

listAlimtalkTemplates(
    externalId: string,
    senderKey: string,
    request?: ListAlimtalkTemplatesRequest,
): Promise<ListAlimtalkTemplatesResponse>
알림톡 템플릿 목록을 조회합니다.

특정 발신 키에 등록된 템플릿 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- Optionalrequest: ListAlimtalkTemplatesRequest
  조회 조건 (선택적)
Returns Promise<ListAlimtalkTemplatesResponse>
템플릿 목록 및 총 개수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await kakaoClient.listAlimtalkTemplates("my-client-1", "SENDER_KEY_123", {
  templateCode: "TEMPLATE_001",
  pageNum: 1,
  pageSize: 20
});
```

createAlimtalkTemplate

createAlimtalkTemplate(
    externalId: string,
    senderKey: string,
    request: CreateAlimtalkTemplateRequest,
): Promise<void>
알림톡 템플릿을 등록합니다.

새로운 알림톡 템플릿을 등록하고 검수를 요청합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateAlimtalkTemplateRequest
  템플릿 등록 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.createAlimtalkTemplate("my-client-1", "SENDER_KEY_123", {
  templateCode: "TEMPLATE_001",
  templateName: "주문 알림",
  templateContent: "#{name}님의 주문이 완료되었습니다.",
  templateMessageType: "BA",
  categoryCode: "001"
});
```

getAlimtalkTemplate

getAlimtalkTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
): Promise<AlimtalkTemplate>
알림톡 템플릿을 조회합니다.

특정 템플릿의 상세 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  템플릿 코드
Returns Promise<AlimtalkTemplate>
템플릿 상세 정보
Throws
NotFoundException 템플릿이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.getAlimtalkTemplate("my-client-1", "SENDER_KEY_123", "TEMPLATE_001");
```

updateAlimtalkTemplate

updateAlimtalkTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateAlimtalkTemplateRequest,
): Promise<void>
알림톡 템플릿을 수정합니다.

기존 템플릿을 수정하고 재검수를 요청합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  템플릿 코드
- request: UpdateAlimtalkTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
NotFoundException 템플릿이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.updateAlimtalkTemplate("my-client-1", "SENDER_KEY_123", "TEMPLATE_001", {
  templateName: "주문 알림(수정)",
  templateContent: "#{name}님의 주문이 접수되었습니다."
});
```

deleteAlimtalkTemplate

deleteAlimtalkTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
): Promise<void>
알림톡 템플릿을 삭제합니다.

등록된 템플릿을 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  템플릿 코드
Returns Promise<void>
Throws
NotFoundException 템플릿이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.deleteAlimtalkTemplate("my-client-1", "SENDER_KEY_123", "TEMPLATE_001");
```

listAlimtalkTemplateComments

listAlimtalkTemplateComments(
    externalId: string,
    senderKey: string,
    templateCode: string,
): Promise<ListAlimtalkTemplateCommentsResponse>
알림톡 템플릿 문의 내역을 조회합니다.

템플릿 검수 관련 문의 내역을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  템플릿 코드
Returns Promise<ListAlimtalkTemplateCommentsResponse>
문의 내역 목록
Throws
NotFoundException 템플릿이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const comments = await kakaoClient.listAlimtalkTemplateComments("my-client-1", "SENDER_KEY_123", "TEMPLATE_001");
```

createAlimtalkTemplateComment

createAlimtalkTemplateComment(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: CreateAlimtalkTemplateCommentRequest,
): Promise<void>
알림톡 템플릿 문의를 등록합니다.

템플릿 검수 관련 문의를 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  템플릿 코드
- request: CreateAlimtalkTemplateCommentRequest
  문의 등록 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
NotFoundException 템플릿이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.createAlimtalkTemplateComment("my-client-1", "SENDER_KEY_123", "TEMPLATE_001", {
  comment: "템플릿 검수 관련 문의드립니다."
});
```

listAlimtalkPlugins

listAlimtalkPlugins(
externalId: string,
senderKey: string,
): Promise<ListAlimtalkPluginsResponse>
알림톡 플러그인 목록을 조회합니다.

특정 발신 키에 등록된 플러그인 목록을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
Returns Promise<ListAlimtalkPluginsResponse>
플러그인 목록 및 총 개수
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const plugins = await kakaoClient.listAlimtalkPlugins("my-client-1", "SENDER_KEY_123");
```

createAlimtalkPlugin

createAlimtalkPlugin(
    externalId: string,
    senderKey: string,
    request: CreateAlimtalkPluginRequest,
): Promise<void>
알림톡 플러그인을 등록합니다.

새로운 플러그인을 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateAlimtalkPluginRequest
  플러그인 등록 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.createAlimtalkPlugin("my-client-1", "SENDER_KEY_123", {
  pluginId: "PLUGIN_001",
  pluginName: "주문 조회",
  pluginUrl: "https://example.com/plugin"
});
```

getAlimtalkPlugin

getAlimtalkPlugin(
    externalId: string,
    senderKey: string,
    pluginId: string,
): Promise<AlimtalkPlugin>
알림톡 플러그인을 조회합니다.

특정 플러그인의 상세 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- pluginId: string
  플러그인 ID
Returns Promise<AlimtalkPlugin>
플러그인 상세 정보
Throws
NotFoundException 플러그인이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const plugin = await kakaoClient.getAlimtalkPlugin("my-client-1", "SENDER_KEY_123", "PLUGIN_001");
```

updateAlimtalkPlugin

updateAlimtalkPlugin(
    externalId: string,
    senderKey: string,
    pluginId: string,
    request: CreateAlimtalkPluginRequest,
): Promise<void>
알림톡 플러그인을 수정합니다.

기존 플러그인 정보를 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- pluginId: string
  플러그인 ID
- request: CreateAlimtalkPluginRequest
  플러그인 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
NotFoundException 플러그인이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.updateAlimtalkPlugin("my-client-1", "SENDER_KEY_123", "PLUGIN_001", {
  pluginName: "주문 조회(수정)",
  pluginUrl: "https://example.com/plugin/v2"
});
```

deleteAlimtalkPlugin

deleteAlimtalkPlugin(
    externalId: string,
    senderKey: string,
    pluginId: string,
): Promise<void>
알림톡 플러그인을 삭제합니다.

등록된 플러그인을 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- pluginId: string
  플러그인 ID
Returns Promise<void>
Throws
NotFoundException 플러그인이 존재하지 않는 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await kakaoClient.deleteAlimtalkPlugin("my-client-1", "SENDER_KEY_123", "PLUGIN_001");
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoAlimtalkTemplateClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoAlimtalkTemplateClient

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>

listAlimtalkTemplateCategories

Parameters

Returns Promise<ListAlimtalkTemplateCategoriesResponse>

Throws

Throws

Example

listAlimtalkTemplates

Parameters

Returns Promise<ListAlimtalkTemplatesResponse>

Throws

Throws

Throws

Example

createAlimtalkTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

getAlimtalkTemplate

Parameters

Returns Promise<AlimtalkTemplate>

Throws

Throws

Throws

Example

updateAlimtalkTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

Throws

Example

deleteAlimtalkTemplate

Parameters

Returns Promise<void>

Throws

Throws

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials