Class KakaoFriendtalkTemplateClient

카카오 친구톡 템플릿 클라이언트

카카오 친구톡 템플릿 기능을 제공합니다. 템플릿 발송 기능과 발송을 위한 템플릿 생성, 수정, 삭제 등의 기능을 포함합니다.

Example

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

// 친구톡 템플릿 목록 조회
const templates = await kakaoTemplateClient.listFriendtalkTemplates("my-client-1");

Constructors

constructor

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

listFriendtalkTemplates

listFriendtalkTemplates(
    externalId: string,
    senderKey: string,
    request?: ListFriendtalkTemplatesRequest,
): Promise<ListFriendtalkTemplatesResponse>
친구톡 템플릿 목록을 조회합니다.

등록된 친구톡 템플릿 목록을 페이징 처리하여 조회합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- Optionalrequest: ListFriendtalkTemplatesRequest
  템플릿 목록 조회 요청 파라미터 (선택적)
Returns Promise<ListFriendtalkTemplatesResponse>
템플릿 목록과 전체 건수
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const templatesResponse = await kakaoClient.listFriendtalkTemplates("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "프로모션",
  pageNum: 1,
  pageSize: 20
});
// templatesResponse: { templates: [{ templateCode: "123", templateName: "프로모션 템플릿", status: "A", ... }], totalCount: 5 }
```

getFriendtalkTemplate

getFriendtalkTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
): Promise<GetFriendtalkTemplateResponse>
친구톡 템플릿 상세 정보를 조회합니다.

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

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.getFriendtalkTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", "TEMPLATE_456");
// template: { template: { templateCode: "TEMPLATE_456", templateName: "프로모션 템플릿", status: "A", ... } }
```

deleteFriendtalkTemplate

deleteFriendtalkTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
): Promise<DeleteFriendtalkTemplateResponse>
친구톡 템플릿을 삭제합니다.

템플릿 코드를 사용하여 등록된 친구톡 템플릿을 삭제합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  삭제할 템플릿 코드
Returns Promise<DeleteFriendtalkTemplateResponse>
삭제 성공 메시지
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await kakaoClient.deleteFriendtalkTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", "TEMPLATE_456");
// result: { templateCode: "TEMPLATE_456" }
```

sendFriendtalkTemplateMessage

sendFriendtalkTemplateMessage(
    externalId: string,
    request: SendFriendtalkTemplateMessageRequest,
    options?: SendOptions,
): Promise<SendFriendtalkMessageResponse>
친구톡 템플릿 메시지를 발송합니다.

등록된 템플릿을 사용하여 친구톡 메시지를 발송합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- request: SendFriendtalkTemplateMessageRequest
  메시지 발송 요청 데이터
- Optionaloptions: SendOptions
Returns Promise<SendFriendtalkMessageResponse>
발송 결과 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const result = await kakaoClient.sendFriendtalkTemplateMessage("my-client-1", {
  senderKey: "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  templateCode: "TEMPLATE_456",
  recipientList: [
    { recipientNo: "01012345678", targeting: "M" }
  ]
});
// result: { requestId: "202301010000000001", sendResults: [{ recipientSeq: 1, resultCode: "MRC01", resultMessage: "성공" }] }
```

createFriendtalkTextTemplate

createFriendtalkTextTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkTextTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>
텍스트형 친구톡 템플릿을 생성합니다.

텍스트만 포함하는 기본 친구톡 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateFriendtalkTextTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateFriendtalkTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.createFriendtalkTextTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "텍스트 안내 템플릿",
  content: "안녕하세요! 이벤트 소식을 알려드립니다.",
  buttons: [
    {
      name: "자세히 보기",
      type: "WL",
      linkMo: "https://example.com/event"
    }
  ]
});
```

updateFriendtalkTextTemplate

updateFriendtalkTextTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkTextTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>
텍스트형 친구톡 템플릿을 수정합니다.

기존에 등록된 텍스트형 친구톡 템플릿의 내용을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  수정할 템플릿 코드
- request: UpdateFriendtalkTextTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<UpdateFriendtalkTemplateResponse>
수정된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const updatedTemplate = await kakaoClient.updateFriendtalkTextTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 텍스트 안내 템플릿",
    content: "안녕하세요! 수정된 이벤트 소식을 알려드립니다.",
    buttons: [
      {
        name: "자세히 보기",
        type: "WL",
        linkMo: "https://example.com/event/updated"
      }
    ]
  }
);
```

createFriendtalkImageTemplate

createFriendtalkImageTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkImageTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>
이미지형 친구톡 템플릿을 생성합니다.

텍스트와 이미지를 포함하는 친구톡 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateFriendtalkImageTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateFriendtalkTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.createFriendtalkImageTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "이미지 안내 템플릿",
  content: "신상품이 출시되었습니다!",
  image: {
    imageUrl: "https://example.com/images/product.jpg",
    imageLink: "https://example.com/product"
  },
  buttons: [
    {
      name: "구매하기",
      type: "WL",
      linkMo: "https://example.com/product/buy"
    }
  ]
});
```

updateFriendtalkImageTemplate

updateFriendtalkImageTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkImageTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>
이미지형 친구톡 템플릿을 수정합니다.

기존에 등록된 이미지형 친구톡 템플릿의 내용을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  수정할 템플릿 코드
- request: UpdateFriendtalkImageTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<UpdateFriendtalkTemplateResponse>
수정된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const updatedTemplate = await kakaoClient.updateFriendtalkImageTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 이미지 안내 템플릿",
    content: "수정된 신상품 소식입니다!",
    image: {
      imageUrl: "https://example.com/images/product-updated.jpg",
      imageLink: "https://example.com/product/updated"
    },
    buttons: [
      {
        name: "구매하기",
        type: "WL",
        linkMo: "https://example.com/product/buy/updated"
      }
    ]
  }
);
```

createFriendtalkWideTemplate

createFriendtalkWideTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkWideImageTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>
와이드 이미지형 친구톡 템플릿을 생성합니다.

텍스트와 와이드 이미지를 포함하는 친구톡 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateFriendtalkWideImageTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateFriendtalkTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.createFriendtalkWideTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "와이드 이미지 템플릿",
  content: "넓은 이미지로 상품을 확인하세요!",
  image: {
    imageUrl: "https://example.com/images/wide-product.jpg",
    imageLink: "https://example.com/product"
  },
  buttons: [
    {
      name: "자세히 보기",
      type: "WL",
      linkMo: "https://example.com/product/detail"
    }
  ]
});
```

updateFriendtalkWideTemplate

updateFriendtalkWideTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkWideImageTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>
와이드 이미지형 친구톡 템플릿을 수정합니다.

기존에 등록된 와이드 이미지형 친구톡 템플릿의 내용을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  수정할 템플릿 코드
- request: UpdateFriendtalkWideImageTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<UpdateFriendtalkTemplateResponse>
수정된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const updatedTemplate = await kakaoClient.updateFriendtalkWideTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 와이드 이미지 템플릿",
    content: "넓은 이미지로 수정된 상품을 확인하세요!",
    image: {
      imageUrl: "https://example.com/images/wide-product-updated.jpg",
      imageLink: "https://example.com/product/updated"
    },
    buttons: [
      {
        name: "자세히 보기",
        type: "WL",
        linkMo: "https://example.com/product/detail/updated"
      }
    ]
  }
);
```

createFriendtalkWideItemListTemplate

createFriendtalkWideItemListTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkWideItemListTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>

와이드 아이템 리스트형 친구톡 템플릿을 생성합니다.

텍스트와 여러 아이템을 리스트로 나열하는 친구톡 템플릿을 생성합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
request: CreateFriendtalkWideItemListTemplateRequest
템플릿 생성 요청 데이터

Returns Promise<CreateFriendtalkTemplateResponse>

생성된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const template = await kakaoClient.createFriendtalkWideItemListTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "상품 리스트 템플릿",
  header: "이번 주 인기 상품",
  item: {
    list: [
      {
        title: "상품 1",
        imageUrl: "https://example.com/images/product1.jpg",
        linkMo: "https://example.com/product1"
      },
      {
        title: "상품 2",
        imageUrl: "https://example.com/images/product2.jpg",
        linkMo: "https://example.com/product2"
      },
      {
        title: "상품 3",
        imageUrl: "https://example.com/images/product3.jpg",
        linkMo: "https://example.com/product3"
      }
    ]
  },
  buttons: [
    {
      name: "전체보기",
      type: "WL",
      linkMo: "https://example.com/products/all"
    }
  ]
});

updateFriendtalkWideItemListTemplate

updateFriendtalkWideItemListTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkWideItemListTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>

와이드 아이템 리스트형 친구톡 템플릿을 수정합니다.

기존에 등록된 와이드 아이템 리스트형 친구톡 템플릿의 내용을 수정합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
templateCode: string
수정할 템플릿 코드
request: UpdateFriendtalkWideItemListTemplateRequest
템플릿 수정 요청 데이터

Returns Promise<UpdateFriendtalkTemplateResponse>

수정된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const updatedTemplate = await kakaoClient.updateFriendtalkWideItemListTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 상품 리스트 템플릿",
    header: "이번 주 수정된 인기 상품",
    item: {
      list: [
        {
          title: "수정된 상품 1",
          imageUrl: "https://example.com/images/product1-updated.jpg",
          linkMo: "https://example.com/product1/updated"
        },
        {
          title: "수정된 상품 2",
          imageUrl: "https://example.com/images/product2-updated.jpg",
          linkMo: "https://example.com/product2/updated"
        },
        {
          title: "수정된 상품 3",
          imageUrl: "https://example.com/images/product3-updated.jpg",
          linkMo: "https://example.com/product3/updated"
        }
      ]
    },
    buttons: [
      {
        name: "전체보기",
        type: "WL",
        linkMo: "https://example.com/products/all/updated"
      }
    ]
  }
);

createFriendtalkPremiumVideoTemplate

createFriendtalkPremiumVideoTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkPremiumVideoTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>
프리미엄 동영상형 친구톡 템플릿을 생성합니다.

텍스트와 동영상을 포함하는 프리미엄 친구톡 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateFriendtalkPremiumVideoTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateFriendtalkTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.createFriendtalkPremiumVideoTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "신제품 소개 동영상",
  content: "신제품 출시 기념 프로모션",
  video: {
    videoUrl: "https://example.com/videos/product-intro.mp4",
    thumbnailUrl: "https://example.com/images/video-cover.jpg"
  },
  buttons: [
    {
      name: "자세히 보기",
      type: "WL",
      linkMo: "https://example.com/product/detail"
    }
  ]
});
```

updateFriendtalkPremiumVideoTemplate

updateFriendtalkPremiumVideoTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkPremiumVideoTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>
프리미엄 동영상형 친구톡 템플릿을 수정합니다.

기존에 등록된 프리미엄 동영상형 친구톡 템플릿의 내용을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  수정할 템플릿 코드
- request: UpdateFriendtalkPremiumVideoTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<UpdateFriendtalkTemplateResponse>
수정된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const updatedTemplate = await kakaoClient.updateFriendtalkPremiumVideoTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 신제품 소개 동영상",
    content: "수정된 신제품 출시 기념 프로모션",
    video: {
      videoUrl: "https://example.com/videos/product-intro-updated.mp4",
      thumbnailUrl: "https://example.com/images/video-cover-updated.jpg"
    },
    buttons: [
      {
        name: "자세히 보기",
        type: "WL",
        linkMo: "https://example.com/product/detail/updated"
      }
    ]
  }
);
```

createFriendtalkCommerceTemplate

createFriendtalkCommerceTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkCommerceTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>
커머스형 친구톡 템플릿을 생성합니다.

상품 정보를 포함하는 커머스용 친구톡 템플릿을 생성합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- request: CreateFriendtalkCommerceTemplateRequest
  템플릿 생성 요청 데이터
Returns Promise<CreateFriendtalkTemplateResponse>
생성된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const template = await kakaoClient.createFriendtalkCommerceTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "상품 프로모션",
  additionalContent: "특별 할인 상품을 확인하세요!",
  image: {
    imageUrl: "https://example.com/images/headphone.jpg"
  },
  commerce: {
    title: "프리미엄 헤드폰",
    regularPrice: 300000,
    discountPrice: 250000,
    discountRate: 16
  },
  buttons: [
    {
      name: "구매하기",
      type: "WL",
      linkMo: "https://example.com/products/headphone/buy"
    }
  ]
});
```

updateFriendtalkCommerceTemplate

updateFriendtalkCommerceTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkCommerceTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>
커머스형 친구톡 템플릿을 수정합니다.

기존에 등록된 커머스형 친구톡 템플릿의 내용을 수정합니다.
Parameters
- externalId: string
  클라이언트 연동 ID
- senderKey: string
  카카오 채널 발신 키
- templateCode: string
  수정할 템플릿 코드
- request: UpdateFriendtalkCommerceTemplateRequest
  템플릿 수정 요청 데이터
Returns Promise<UpdateFriendtalkTemplateResponse>
수정된 템플릿 정보
Throws
InvalidParameterException 요청 데이터가 유효하지 않은 경우

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

Throws
InternalServerErrorException 서버 오류가 발생한 경우
Example
```
const updatedTemplate = await kakaoClient.updateFriendtalkCommerceTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 상품 프로모션",
    additionalContent: "수정된 특별 할인 상품을 확인하세요!",
    image: {
      imageUrl: "https://example.com/images/headphone-updated.jpg"
    },
    commerce: {
      title: "프리미엄 헤드폰 2세대",
      regularPrice: 350000,
      discountPrice: 280000,
      discountRate: 20
    },
    buttons: [
      {
        name: "구매하기",
        type: "WL",
        linkMo: "https://example.com/products/headphone/buy/updated"
      }
    ]
  }
);
```

createFriendtalkCarouselFeedTemplate

createFriendtalkCarouselFeedTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkCarouselFeedTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>

캐러셀 피드형 친구톡 템플릿을 생성합니다.

여러 컨텐츠를 슬라이드 형태로 보여주는 캐러셀 피드형 친구톡 템플릿을 생성합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
request: CreateFriendtalkCarouselFeedTemplateRequest
템플릿 생성 요청 데이터

Returns Promise<CreateFriendtalkTemplateResponse>

생성된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const template = await kakaoClient.createFriendtalkCarouselFeedTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "이달의 추천 컨텐츠",
  carousel: {
    list: [
      {
        header: "여름 휴가 특집",
        message: "올 여름 추천 여행지",
        imageUrl: "https://example.com/images/summer-vacation.jpg",
        imageLink: "https://example.com/travel/summer",
        buttons: [
          {
            name: "자세히 보기",
            type: "WL",
            linkMo: "https://example.com/travel/summer/detail"
          }
        ]
      },
      {
        header: "건강 레시피",
        message: "여름철 보양식 레시피",
        imageUrl: "https://example.com/images/healthy-food.jpg",
        imageLink: "https://example.com/recipes/summer",
        buttons: [
          {
            name: "레시피 보기",
            type: "WL",
            linkMo: "https://example.com/recipes/summer/detail"
          }
        ]
      }
    ]
  }
});

updateFriendtalkCarouselFeedTemplate

updateFriendtalkCarouselFeedTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkCarouselFeedTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>

캐러셀 피드형 친구톡 템플릿을 수정합니다.

기존에 등록된 캐러셀 피드형 친구톡 템플릿의 내용을 수정합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
templateCode: string
수정할 템플릿 코드
request: UpdateFriendtalkCarouselFeedTemplateRequest
템플릿 수정 요청 데이터

Returns Promise<UpdateFriendtalkTemplateResponse>

수정된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const updatedTemplate = await kakaoClient.updateFriendtalkCarouselFeedTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 이달의 추천 컨텐츠",
    carousel: {
      list: [
        {
          header: "수정된 여름 휴가 특집",
          message: "올 여름 수정된 추천 여행지",
          imageUrl: "https://example.com/images/summer-vacation-updated.jpg",
          imageLink: "https://example.com/travel/summer/updated",
          buttons: [
            {
              name: "자세히 보기",
              type: "WL",
              linkMo: "https://example.com/travel/summer/detail/updated"
            }
          ]
        },
        {
          header: "수정된 건강 레시피",
          message: "여름철 수정된 보양식 레시피",
          imageUrl: "https://example.com/images/healthy-food-updated.jpg",
          imageLink: "https://example.com/recipes/summer/updated",
          buttons: [
            {
              name: "레시피 보기",
              type: "WL",
              linkMo: "https://example.com/recipes/summer/detail/updated"
            }
          ]
        }
      ]
    }
  }
);

createFriendtalkCarouselCommerceTemplate

createFriendtalkCarouselCommerceTemplate(
    externalId: string,
    senderKey: string,
    request: CreateFriendtalkCarouselCommerceTemplateRequest,
): Promise<CreateFriendtalkTemplateResponse>

캐러셀 커머스형 친구톡 템플릿을 생성합니다.

여러 상품 정보를 슬라이드 형태로 보여주는 캐러셀 커머스형 친구톡 템플릿을 생성합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
request: CreateFriendtalkCarouselCommerceTemplateRequest
템플릿 생성 요청 데이터

Returns Promise<CreateFriendtalkTemplateResponse>

생성된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const template = await kakaoClient.createFriendtalkCarouselCommerceTemplate("my-client-1", "209880bcc4817fc57ba1d5ce69d863d379a1c881", {
  templateName: "이달의 베스트셀러",
  carousel: {
    list: [
      {
        additionalContent: "가전 제품 특가",
        imageUrl: "https://example.com/images/tv.jpg",
        imageLink: "https://example.com/products/tv",
        commerce: {
          title: "스마트 TV",
          regularPrice: 1000000,
          discountPrice: 800000,
          discountRate: 20
        },
        buttons: [
          {
            name: "구매하기",
            type: "WL",
            linkMo: "https://example.com/products/tv/buy"
          }
        ]
      },
      {
        additionalContent: "주방용품 특가",
        imageUrl: "https://example.com/images/airfryer.jpg",
        imageLink: "https://example.com/products/airfryer",
        commerce: {
          title: "에어프라이어",
          regularPrice: 200000,
          discountPrice: 150000,
          discountRate: 25
        },
        buttons: [
          {
            name: "구매하기",
            type: "WL",
            linkMo: "https://example.com/products/airfryer/buy"
          }
        ]
      }
    ]
  }
});

updateFriendtalkCarouselCommerceTemplate

updateFriendtalkCarouselCommerceTemplate(
    externalId: string,
    senderKey: string,
    templateCode: string,
    request: UpdateFriendtalkCarouselCommerceTemplateRequest,
): Promise<UpdateFriendtalkTemplateResponse>

캐러셀 커머스형 친구톡 템플릿을 수정합니다.

기존에 등록된 캐러셀 커머스형 친구톡 템플릿의 내용을 수정합니다.

Parameters

externalId: string
클라이언트 연동 ID
senderKey: string
카카오 채널 발신 키
templateCode: string
수정할 템플릿 코드
request: UpdateFriendtalkCarouselCommerceTemplateRequest
템플릿 수정 요청 데이터

Returns Promise<UpdateFriendtalkTemplateResponse>

수정된 템플릿 정보

Throws

InvalidParameterException 요청 데이터가 유효하지 않은 경우

Throws

AccessDeniedException API 호출 권한이 없는 경우

Throws

InternalServerErrorException 서버 오류가 발생한 경우

Example

const updatedTemplate = await kakaoClient.updateFriendtalkCarouselCommerceTemplate(
  "my-client-1",
  "209880bcc4817fc57ba1d5ce69d863d379a1c881",
  "TEMPLATE_CODE_456",
  {
    templateName: "수정된 이달의 베스트셀러",
    carousel: {
      list: [
        {
          additionalContent: "수정된 가전 제품 특가",
          imageUrl: "https://example.com/images/tv-updated.jpg",
          imageLink: "https://example.com/products/tv/updated",
          commerce: {
            title: "스마트 TV 2023",
            regularPrice: 1200000,
            discountPrice: 950000,
            discountRate: 21
          },
          buttons: [
            {
              name: "구매하기",
              type: "WL",
              linkMo: "https://example.com/products/tv/buy/updated"
            }
          ]
        },
        {
          additionalContent: "수정된 주방용품 특가",
          imageUrl: "https://example.com/images/airfryer-updated.jpg",
          imageLink: "https://example.com/products/airfryer/updated",
          commerce: {
            title: "스마트 에어프라이어",
            regularPrice: 250000,
            discountPrice: 170000,
            discountRate: 32
          },
          buttons: [
            {
              name: "구매하기",
              type: "WL",
              linkMo: "https://example.com/products/airfryer/buy/updated"
            }
          ]
        }
      ]
    }
  }
);

Properties

`Protected`credentials

credentials: AwesomeMessageCredentials

API 인증 크레덴셜

Class KakaoFriendtalkTemplateClient

Example

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns KakaoFriendtalkTemplateClient

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>

listFriendtalkTemplates

Parameters

Returns Promise<ListFriendtalkTemplatesResponse>

Throws

Throws

Throws

Example

getFriendtalkTemplate

Parameters

Returns Promise<GetFriendtalkTemplateResponse>

Throws

Throws

Throws

Example

deleteFriendtalkTemplate

Parameters

Returns Promise<DeleteFriendtalkTemplateResponse>

Throws

Throws

Throws

Example

sendFriendtalkTemplateMessage

Parameters

Returns Promise<SendFriendtalkMessageResponse>

Throws

Throws

Throws

Example

createFriendtalkTextTemplate

Parameters

Returns Promise<CreateFriendtalkTemplateResponse>

Throws

Throws

Throws

Example

updateFriendtalkTextTemplate

Parameters

Returns Promise<UpdateFriendtalkTemplateResponse>

Throws

Throws

Throws

`Protected`createSendHeaders

`Protected`get

`Protected`post

`Protected`postFormData

`Protected`put

`Protected`delete

`Protected`deleteWithBody