본문으로 건너뛰기

피드 템플릿으로 메시지 전송하기

피드 템플릿​

공식 문서

이미지와 글로 구성된 기본 메시지 형식입니다. 아이템 목록을 포함할 수 있습니다.

스크랩 메시지를 보낼 때도 피드 템플릿 구조를 사용합니다.

스크랩 메시지는 요청한 웹 페이지 URL에서 오픈 그래프 프로토콜(Open Graph Protocol)을 기반으로 웹 페이지 정보를 읽어와 구성한 메시지 형식입니다.

활용 예시: 서비스의 새로운 소식이나 프로모션 이벤트를 공유하는 데 사용할 수 있습니다. 간편하게 웹 페이지를 공유할 때는 스크랩 메시지를 활용합니다. 아이템 영역을 사용하면 주문 내역, 카탈로그, 영수증과 같은 형태의 피드 메시지를 만들 수 있습니다.

템플릿 타입 정의​

/**
 * 기본 템플릿으로 제공되는 피드 템플릿 클래스.
 *
 * @property content 메시지의 메인 콘텐츠 정보
 * @property itemContent 아이템 영역에 포함할 콘텐츠, [ItemContent] 참고
 * @property social 콘텐츠에 대한 소셜 정보
 * @property buttons 버튼 목록, 최대 2개. 버튼 타이틀과 링크를 변경하고 싶을 때, 버튼 두 개를 넣고 싶을 때 사용
 * @property buttonTitle 기본 버튼 타이틀(자세히 보기)을 변경하고 싶을 때 설정. 이 값을 사용하면 클릭 시 이동할 링크는 content 에 입력된 값이 사용됨.
 */
export interface KakaoFeedTemplate {
  content: KakaoTemplateContent;
  itemContent?: KakaoTemplateItemContent;
  social?: KakaoTemplateSocial;
  buttons?: KakaoTemplateButton[];
  buttonTitle?: string;
}

나에게 메시지 전송하기​

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

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

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

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

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

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

정보

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

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