이 문서는 카카오 또는 공동체 서비스용 카카오톡 공유 API를 소개합니다. 공통 설명은 오픈 문서를 참고합니다.

• 카카오톡 공유 이해하기

• 기능 소개

인하우스 또는 공동체 서비스의 앱은 카카오톡 공유 사용 시, 권한 목록의 추가 기능과 API를 권한 획득 후 사용할 수 있습니다.

인하우스 앱은 카카오톡 채널로 사용자에게 메시지를 보내는 카카오톡 채널 메시지 기능을 사용할 수 있습니다.

• 사용 방법

• 카카오톡 공유 발송 흐름

• 메시지 발송 기능 안내

• 카카오톡 공유와 카카오톡 메시지의 기능 차이

• 메시지 템플릿

인하우스 또는 공동체 서비스의 앱은 메시지 템플릿 도구에서 일반 앱보다 많은 설정을 제공합니다. 자세한 내용은 메시지 템플릿 도구를 참고합니다.

인하우스 또는 공동체 서비스의 앱은 공유 대상 선택 화면에 옵션 배너와 바텀 메뉴를 추가할 수 있습니다.

옵션 배너와 바텀 메뉴는 서비스 부서에서 직접 설정할 수 없어 아래 절차대로 요청해야 합니다.

1. proj_공유피커개선 아지트에서 [카카오톡 공유] 커스텀 피커 사용 요청 양식을 작성해 커스텀 사양을 논의 및 확정합니다.
2. 전 단계에서 확정된 내용을 포함해서 [서비스] API플랫폼 아지트의 [카카오톡 공유] 커스텀 피커 사용 요청 양식을 작성해 템플릿 등록 또는 수정을 요청합니다.
3. API플랫폼 담당자가 통합 API 어드민에 템플릿을 대신 등록합니다. 등록한 템플릿의 그룹 ID는 서비스 담당자에게 전달될 예정입니다.
4. 서비스에서는 카카오톡 공유 API 호출 시, API플랫폼 담당자로부터 전달받은 템플릿 그룹 ID를 파라미터로 전달해야 합니다. (참고: 예제)
   • 현재는 JavaScript SDK만 지원합니다. (참고: 지원 조건)

이후 템플릿 수정이 필요하면 API플랫폼 담당자에게 요청합니다.

공유 대상 선택 화면은 다음과 같이 구성되며, 필요한 기능을 선별해 개별적으로 사용할 수 있습니다.

공유 대상 선택 화면 커스텀 요소

• [A] 대상 목록, 파라미터로 필터링 가능, 카카오톡 공유 대상 선택 화면 설정 참고
• [B] 옵션 배너
• [C] 바텀 메뉴

옵션 배너는 공유 대상 선택 화면 상단에 노출됩니다.

공유와 관련된 상태, 조건, 설정, 안내 정보를 표시할 수 있으며, 사용자가 선택한 조건에 따라 전송되는 메시지를 동적으로 변경할 수 있습니다. 서비스 팀에서 한국어, 영어, 일본어를 직접 제공해야 합니다.

옵션 배너는 UX플랫폼팀에서 제공하는 옵션 배너 UX 가이드를 반드시 준수해야 합니다.

옵션 배너 유형

바텀 메뉴는 공유 대상 선택 화면 하단에 노출됩니다. 선택한 콘텐츠를 다양한 공유 채널로 확장할 수 있는 보조 UI입니다. 한국어, 영어, 일본어를 지원합니다.

기본적으로는 나에게 아이콘만 노출되나, 필요에 따라 아래 기능을 추가로 사용할 수 있습니다. 사용을 원할 경우, [필요한 값]을 템플릿 등록 요청 시 함께 전달해야 합니다.

바텀 메뉴는 UX플랫폼팀에서 제공하는 바텀 메뉴 UX 가이드를 반드시 준수해야 합니다.

카카오톡 공유 대상 선택 화면을 커스텀 설정하려면 카카오톡 공유 API 호출 시, pickerSettings 객체에 아래 파라미터를 설정합니다.

Kakao.Share.sendCustom({
  templateId: ${YOUR_TEMPLATE_ID},
  templateArgs: {
    title: '제목 영역입니다.',
    description: '설명 영역입니다.',
  },
  pickerSettings: {
    type: "chat",
    limit: 1,
    groupId: 1,
    logs: {
      key: "value",
    },
    args: {
      title: "Picker Title",
      desc: "Picker Description",
    },
  },
});

• 이용 정책
  • 쿼터
  • 카카오톡 공유 웹훅
  • 스크랩 허용을 위한 방화벽 설정
  • 카카오톡 최소 지원 버전
  • OS 공유 사용

• 제공 API