본문으로 건너뛰기

리스트 템플릿으로 메시지 전송하기

리스트 템플릿​

공식 문서

한 개 이상의 콘텐츠를 세로로 된 목록 형태로 보여주는 메시지 형식입니다. 각 목록은 이미지와 글로 구성할 수 있습니다.

활용 예시: 메시지 하나로 여러 개의 소식이나 상품을 안내하는 데 적합합니다.

템플릿 타입 정의​

/**
 * 여러 개의 컨텐츠를 리스트 형태로 보여줄 수 있는 메시지 템플릿 클래스.
 *
 * @property headerTitle 리스트 상단에 노출되는 헤더 타이틀 (최대 200자)
 * @property headerLink 헤더 타이틀 내용에 해당하는 링크 정보
 * @property contents 리스트에 노출되는 컨텐츠 목록 (최소 2개, 최대 3개)
 * @property buttons 버튼 목록. 버튼 타이틀과 링크를 변경하고 싶을때, 버튼 두개를 사용하고 싶을때 사용. (최대 2개)
 * @property buttonTitle 기본 버튼 타이틀(자세히 보기)을 변경하고 싶을 때 설정. 이 값을 사용하면 클릭 시 이동할 링크는 content 에 입력된 값이 사용됨.
 */
export interface KakaoListTemplate {
  headerTitle: string;
  headerLink: KakaoTemplateLink;
  contents: KakaoTemplateContent[];
  buttons?: KakaoTemplateButton[];
  buttonTitle?: string;
}

나에게 메시지 전송하기​

sendListTemplateToMe로 템플릿 메시지를 나에게 전송할 수 있습니다.

export function sendListTemplateToMe(params: {
  template: KakaoListTemplate;
})
  • template: 템플릿 객체입니다.

친구들에게 메시지 전송하기​

sendListTemplateToFriends로 템플릿 메시지를 친구들에게 전송할 수 있습니다.

export function sendListTemplateToFriends(params: {
  template: KakaoListTemplate;
  receiverUuids: string[];
  includeFailureInfo?: boolean;
})

includeFailureInfo: true를 전달하면 성공 UUID와 오류별 실패 수신자를 함께 반환합니다. 옵션을 생략하면 성공 UUID 배열을 반환합니다. 발송 결과를 참고하세요.

정보

자세한 컴포넌트 타입은 컴포넌트 타입들을 참고하세요.

사용 중 문제가 생기면 문제 해결을 참고하세요.