Class KakaoChannelClient

카카오 비즈니스 채널 클라이언트

카카오 비즈니스 채널 관리 API 기능을 제공합니다. 친구톡/알림톡 발송을 위한 채널 등록, 인증, 조회, 삭제 등의 기능을 포함합니다.

Example

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

// 채널 카테고리 조회
const categories = await kakaoChannelClient.getChannelCategories({
  externalId: "my-client-1"
});

Index

Constructors

constructor

new KakaoChannelClient(
credentials: AwesomeMessageCredentials,
): KakaoChannelClient
카카오 비즈니스 채널 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoChannelClient
Example
```
const kakaoChannelClient = new KakaoChannelClient({
  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

getChannelCategories

getChannelCategories(externalId: string): Promise<KakaoChannelCategory[]>
카카오 채널 카테고리 목록을 조회합니다.

카카오 채널 등록 시 선택할 수 있는 카테고리 목록을 반환합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
Returns Promise<KakaoChannelCategory[]>
카테고리 목록
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const getChannelCategoriesResponse = await kakaoChannelClient.getChannelCategories("my-client-1");
// getChannelCategoriesResponse: [{ parentCode: "001", depth: 1, code: "001001", name: "쇼핑/유통", subCategories: [...] }]
```

createChannel

createChannel(
externalId: string,
request: CreateKakaoChannelRequest,
): Promise<CreateKakaoChannelResponse>
새로운 카카오 채널을 등록합니다.

플러스친구 ID와 카테고리 정보를 사용하여 새로운 카카오 채널을 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: CreateKakaoChannelRequest
  채널 등록 요청 데이터
Returns Promise<CreateKakaoChannelResponse>
등록된 채널 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const createChannelResponse = await kakaoChannelClient.createChannel("my-client-1", {
  plusFriendId: "@mycompany",
  phoneNo: "01500000000",
  categoryCode: "01800010001"
});
// createChannelResponse: { plusFriendId: "@mycompany" }
```

authenticateChannelToken

authenticateChannelToken(
externalId: string,
request: AuthenticateKakaoChannelTokenRequest,
): Promise<AuthenticateKakaoChannelTokenResponse>
카카오 채널 토큰을 인증합니다.

카카오톡 앱에서 받은 인증 토큰을 사용하여 채널을 인증합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: AuthenticateKakaoChannelTokenRequest
  토큰 인증 요청 데이터
Returns Promise<AuthenticateKakaoChannelTokenResponse>
인증된 채널 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
InvalidChannelTokenException 카카오 채널 토큰이 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const authenticateChannelTokenResponse = await kakaoChannelClient.authenticateChannelToken("my-client-1", {
  plusFriendId: "@mycompany",
  token: 123456
});
// authenticateChannelTokenResponse: { plusFriendId: "@mycompany", senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881", status: "YSC03" }
```

listChannels

listChannels(
externalId: string,
request?: ListKakaoChannelsRequest,
): Promise<ListKakaoChannelsResponse>
등록된 카카오 채널 목록을 조회합니다.

클라이언트에 등록된 카카오 채널들의 목록을 조회합니다. 필터 조건을 사용하여 원하는 채널만 조회할 수 있습니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- Optionalrequest: ListKakaoChannelsRequest
  채널 목록 조회 요청 파라미터 (선택적)
Returns Promise<ListKakaoChannelsResponse>
채널 목록과 전체 건수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const listChannelsResponse = await kakaoChannelClient.listChannels("my-client-1", {
  status: "YSC03",
  pageNum: 1,
  pageSize: 10
});
// listChannelsResponse: { senders: [{ plusFriendId: "@mycompany", senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881", status: "YSC03" }], totalCount: 5 }
```

getChannel

getChannel(externalId: string, senderKey: string): Promise<KakaoChannelInfo>
특정 카카오 채널의 상세 정보를 조회합니다.

발신 키를 사용하여 특정 카카오 채널의 상세 정보를 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  조회할 채널의 발신 키
Returns Promise<KakaoChannelInfo>
채널 상세 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
InvalidSenderKeyException 카카오 채널 발신 키가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const getChannelResponse = await kakaoChannelClient.getChannel("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881");
// getChannelResponse: { plusFriendId: "@mycompany", senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881", status: "YSC03", statusName: "정상 등록" }
```

deleteChannel

deleteChannel(
externalId: string,
request: DeleteKakaoChannelRequest,
): Promise<DeleteKakaoChannelResponse>
카카오 채널을 삭제합니다.

발신 키를 사용하여 등록된 카카오 채널을 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: DeleteKakaoChannelRequest
  채널 삭제 요청 데이터
Returns Promise<DeleteKakaoChannelResponse>
삭제된 채널 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws
InvalidSenderKeyException 카카오 채널 발신 키가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const deleteChannelResponse = await kakaoChannelClient.deleteChannel("my-client-1", {
  senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881"
});
// deleteChannelResponse: { senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881" }
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoChannelClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoChannelClient

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>

getChannelCategories

Parameters

Returns Promise<KakaoChannelCategory[]>

Throws

Throws

Throws

Example

createChannel

Parameters

Returns Promise<CreateKakaoChannelResponse>

Throws

Throws

Throws

Example

authenticateChannelToken

Parameters

Returns Promise<AuthenticateKakaoChannelTokenResponse>

Throws

Throws

Throws

Throws

Example

listChannels

Parameters

Returns Promise<ListKakaoChannelsResponse>

Throws

Throws

Throws

Example

getChannel

Parameters

Returns Promise<KakaoChannelInfo>

Throws

Throws

Throws

Throws

Example

deleteChannel

Parameters

Returns Promise<DeleteKakaoChannelResponse>

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials