Class KakaoFriendtalkManagementClient

카카오 친구톡 관리 클라이언트

카카오 친구톡 발신 프로필, 수신거부, 대체 발송, 마케팅 수신동의, 비즈폼 관리 기능을 제공합니다.

Example

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

// 발신 프로필 조회
const profile = await managementClient.getFriendtalkSenderProfile("my-client-1", "SENDER_KEY");

Index

Constructors

constructor

new KakaoFriendtalkManagementClient(
credentials: AwesomeMessageCredentials,
): KakaoFriendtalkManagementClient
카카오 친구톡 관리 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoFriendtalkManagementClient
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

getFriendtalkSenderProfile

getFriendtalkSenderProfile(
externalId: string,
senderKey: string,
): Promise<GetFriendtalkSenderProfileResponse>
친구톡 발신 프로필을 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
Returns Promise<GetFriendtalkSenderProfileResponse>
발신 프로필 정보
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const profile = await managementClient.getFriendtalkSenderProfile("my-client-1", "SENDER_KEY");
```

updateFriendtalkUnsubscribe

updateFriendtalkUnsubscribe(
    externalId: string,
    senderKey: string,
    data: UpdateFriendtalkUnsubscribeRequest,
): Promise<void>
080 수신거부번호를 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
- data: UpdateFriendtalkUnsubscribeRequest
  수신거부번호 수정 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await managementClient.updateFriendtalkUnsubscribe("my-client-1", "SENDER_KEY", {
  unsubscribeNo: "08012345678"
});
```

registerFriendtalkFailbackAppKey

registerFriendtalkFailbackAppKey(
externalId: string,
data: RegisterFriendtalkFailbackAppKeyRequest,
): Promise<void>
대체 발송 SMS AppKey를 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- data: RegisterFriendtalkFailbackAppKeyRequest
  AppKey 등록 요청 데이터
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await managementClient.registerFriendtalkFailbackAppKey("my-client-1", {
  resendAppKey: "sms-app-key-123"
});
```

registerFriendtalkFailbackSettings

registerFriendtalkFailbackSettings(
    externalId: string,
    senderKey: string,
    data: Omit<RegisterFriendtalkFailbackRequest, "senderKey">,
): Promise<void>
대체 발송 설정을 등록합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
- data: Omit<RegisterFriendtalkFailbackRequest, "senderKey">
  대체 발송 설정 데이터 (senderKey 제외, 자동 포함됨)
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await managementClient.registerFriendtalkFailbackSettings("my-client-1", "SENDER_KEY", {
  isResend: true,
  resendSendNo: "01012345678",
  resendUnsubscribeNo: "08012345678"
});
```

uploadFriendtalkMarketingConsent

uploadFriendtalkMarketingConsent(
    externalId: string,
    senderKey: string,
    file: Buffer,
    filename?: string,
): Promise<void>
마케팅 수신동의 증적 파일을 업로드합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
- file: Buffer
  업로드할 파일 (Buffer)
- Optionalfilename: string
  파일명 (선택)
Returns Promise<void>
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const fs = require('fs');
const fileBuffer = fs.readFileSync('consent.csv');
await managementClient.uploadFriendtalkMarketingConsent("my-client-1", "SENDER_KEY", fileBuffer, "consent.csv");
```

applyFriendtalkMarketingAgreement

applyFriendtalkMarketingAgreement(
externalId: string,
senderKey: string,
): Promise<void>
마케팅 수신동의 사용을 신청합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
Returns Promise<void>
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await managementClient.applyFriendtalkMarketingAgreement("my-client-1", "SENDER_KEY");
```

uploadFriendtalkBizFormKey

uploadFriendtalkBizFormKey(externalId: string, senderKey: string): Promise<void>
비즈폼 키를 업로드합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  발신 키
Returns Promise<void>
Throws
AccessDeniedException API 호출 권한이 없는 경우

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
await managementClient.uploadFriendtalkBizFormKey("my-client-1", "SENDER_KEY");
```

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoFriendtalkManagementClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoFriendtalkManagementClient

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>

getFriendtalkSenderProfile

Parameters

Returns Promise<GetFriendtalkSenderProfileResponse>

Throws

Throws

Example

updateFriendtalkUnsubscribe

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

registerFriendtalkFailbackAppKey

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

registerFriendtalkFailbackSettings

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

uploadFriendtalkMarketingConsent

Parameters

Returns Promise<void>

Throws

Throws

Throws

Example

applyFriendtalkMarketingAgreement

Parameters

Returns Promise<void>

Throws

Throws

Example

uploadFriendtalkBizFormKey

Parameters

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody

`Protected`credentials