Class KakaoFriendtalkImageClient

카카오 친구톡 이미지 클라이언트

카카오 친구톡 이미지 기능을 제공합니다. 템플릿 발송과 자유형 발송에서 사용되는 이미지 업로드, 조회, 삭제 등의 기능을 포함합니다.

Example

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

// 친구톡 이미지 목록 조회
const images = await kakaoImageClient.listFriendtalkImages("my-client-1");

Index

Constructors

constructor

new KakaoFriendtalkImageClient(
credentials: AwesomeMessageCredentials,
): KakaoFriendtalkImageClient
카카오 친구톡 이미지 클라이언트 생성자
Parameters
- credentials: AwesomeMessageCredentials
  API 인증 크레덴셜
Returns KakaoFriendtalkImageClient
Example
```
const client = new KakaoFriendtalkImageClient({
  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

listFriendtalkImages

listFriendtalkImages(
externalId: string,
request: ListFriendtalkUploadedImagesRequest,
): Promise<ListFriendtalkUploadedImagesResponse>
친구톡 이미지 목록을 조회합니다.

클라이언트에 등록된 친구톡 이미지 목록을 조회합니다. 필터 조건을 사용하여 이미지 타입별로 조회할 수 있습니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: ListFriendtalkUploadedImagesRequest
  이미지 목록 조회 요청 파라미터
Returns Promise<ListFriendtalkUploadedImagesResponse>
이미지 목록과 전체 건수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const imagesResponse = await kakaoImageClient.listFriendtalkImages("my-client-1", {
  imageTypes: ["IMAGE", "WIDE_IMAGE"],
  pageNum: "1",
  pageSize: "20"
});
// imagesResponse: { images: [{ imageSeq: 123, imageUrl: "https://...", imageName: "product1.jpg" }], totalCount: 5 }
```

uploadFriendtalkImage

uploadFriendtalkImage(
externalId: string,
request: UploadFriendtalkImageRequest,
): Promise<UploadFriendtalkImageResponse>
친구톡 이미지를 업로드합니다.

친구톡 메시지에서 사용할 이미지를 업로드합니다. 이미지 타입에 따라 친구톡 메시지 형식별로 사용 가능한 이미지가 달라집니다.

지원하는 이미지 형식: JPG, PNG만 지원
Parameters
- externalId: string
  클라이언트 연동 ID
- request: UploadFriendtalkImageRequest
  이미지 업로드 요청 데이터
  
  친구톡 이미지 업로드 요청
  - imageFile: Buffer
    이미지 파일
  - friendtalkImageType: FriendtalkImageType
    친구톡 업로드 이미지 타입
  - Optionalfilename?: string
    파일명
Returns Promise<UploadFriendtalkImageResponse>
업로드된 이미지 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우 (JPG/PNG가 아닌 파일 업로드 시 포함)

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
// Node.js 환경에서:
const fs = require('fs');
const fileBuffer = fs.readFileSync('image.jpg'); // JPG 또는 PNG 파일
const result = await kakaoImageClient.uploadFriendtalkImage(
  "my-client-1",
  {
    imageFile: fileBuffer,
    friendtalkImageType: "IMAGE",
    filename: "image.jpg"
  }
);

// 파일명을 명시적으로 지정하고 싶은 경우:
const result = await kakaoImageClient.uploadFriendtalkImage(
  "my-client-1",
  {
    imageFile: fileBuffer,
    friendtalkImageType: "IMAGE",
    filename: "my-image.jpg"
  }
);

// result: { image: { imageSeq: 123, imageUrl: "https://..." } }
```

deleteFriendtalkImage

deleteFriendtalkImage(externalId: string, imageSeq: number): Promise<void>
친구톡 이미지를 삭제합니다.

업로드된 친구톡 이미지를 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- imageSeq: number
  삭제할 이미지의 시퀀스 번호
Returns Promise<void>
void
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

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

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoFriendtalkImageClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoFriendtalkImageClient

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>

listFriendtalkImages

Parameters

Returns Promise<ListFriendtalkUploadedImagesResponse>

Throws

Throws

Throws

Example

uploadFriendtalkImage

Parameters

imageFile: Buffer

friendtalkImageType: FriendtalkImageType

Optionalfilename?: string

Returns Promise<UploadFriendtalkImageResponse>

Throws

Throws

Throws

Example

deleteFriendtalkImage

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

`Optional`filename?: string

`Protected`credentials