사이드 메뉴
커뮤니케이션
API 제공
어드민 API
카카오톡 공유
웹훅
이 문서는 카카오 또는 공동체 서비스용 카카오톡 공유 관련 웹훅 정보를 안내합니다.
이용 정책에서 웹훅 사용 시 주의 사항을 확인해야 합니다.
| 메서드 | URL | 필수 응답 규격 | 인증 방식 |
|---|---|---|---|
GET/POST | 앱 관리 페이지의 [앱] > [웹훅] > [카카오톡 공유 웹훅]에 등록한 웹훅 URL | HTTP 상태 코드 2XX (3초 내) | 대표 어드민 키 |
| 권한 | 사전 설정 | 카카오 로그인 | 동의항목 |
|---|---|---|---|
| - | 어드민 키 카카오톡 공유 웹훅 | - | - |
카카오톡 공유 웹훅은 사용자가 선택한 친구 또는 채팅방으로 카카오톡 공유 메시지가 성공적으로 전달된 경우, 카카오가 해당 사실을 서비스로 전달하는 기능입니다. 웹훅을 수신한 서비스는 HTTP 상태 코드 2XX로 3초 내에 응답해야 합니다.
카카오톡 공유 웹훅의 사용 방법은 카카오톡 공유 웹훅을 참고합니다. 카카오 및 공동체에 웹훅으로 제공하는 추가 정보는 아래를 참고합니다.
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| Authorization | String | Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}유효한 웹훅인지 판단할 수 있도록 전달하는 대표 어드민 키 | O |
| X-Kakao-Resource-ID | String | X-Kakao-Resource-ID: ${UNIQUE_ID}각 웹훅의 구분을 위한 고유 ID | O |
| User-Agent | String | User-Agent: KakaoOpenAPI/1.0카카오에서 보낸 웹훅임을 알리기 위한 문자열 | O |
- 웹훅은 아래 필드 외에
serverCallbackArgs파라미터로 전달한 키와 값을 포함합니다.
Kakao
: 카카오 서비스의 앱에만 전달하는 파라미터, 공동체에는 제공 불가
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| CHAT_TYPE | String | 카카오톡 공유 메시지를 수신한 채팅방의 타입, 아래 중 하나
| O |
| HASH_CHAT_ID | String | 카카오톡 공유 메시지를 수신한 채팅방의 참고용 ID 서비스별로 유일(Unique)한 해시(Hash) 값으로 같은 채팅방이라도 서비스마다 다른 값 제공 | O |
| TEMPLATE_ID | Long | 메시지 템플릿 ID를 사용해 카카오톡 공유 메시지를 보낸 경우 사용된 메시지 템플릿의 ID 메시지 템플릿 ID를 사용해 요청하지 않은 경우 전달되지 않음 | X |
| IS_SINGLE_CHATROOM | Boolean | 카카오톡 공유 메시지를 수신한 채팅방이 발신자만 참여 중이거나, 발신자만 남아있는 채팅방인지 여부
CHAT_TYPE이 MultiChat이지만 발신자만 참여 중인 경우 true로 응답)중요: 인하우스 앱 또는 카카오톡 공유 유료 사용 설정을 활성화한 앱만 전달 | X |
| CHAT_MEMBER_COUNT_RANGE | String | 카카오톡 공유 메시지를 수신한 채팅방의 참여자 수 범위, 아래 중 하나
중요: 인하우스 앱 또는 카카오톡 공유 유료 사용 설정을 활성화한 앱만 전달 | X |
| USER_ID Kakao | Number | 카카오 로그인을 사용하는 서비스일 경우, 발신자 회원번호 | X |
| ACCOUNT_ID Kakao | Number | 카카오 로그인을 사용하는 서비스일 경우, 발신자 카카오계정 ID | X |
- HTTP 상태 코드
2XX(3초 내)
요청: GET 메서드
curl -v -G GET "${KAKAOLINK_CALLBACK_URL}?CHAT_TYPE=MemoChat&HASH_CHAT_ID=${HASH_CHAT_ID}&IS_SINGLE_CHATROOM=false&CHAT_MEMBER_COUNT_RANGE=1+&TEMPLATE_ID=10000&custom_parameter_key=custom_parameter_value" \-H "Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}" \-H "X-Kakao-Resource-ID: ${UNIQUE_ID}" \-H "User-Agent: KakaoOpenAPI/1.0"
요청: POST 메서드
curl -v -X POST "${KAKAOLINK_CALLBACK_URL}" \-H "Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}" \-H "X-Kakao-Resource-ID: ${UNIQUE_ID}" \-H "User-Agent: KakaoOpenAPI/1.0" \-H "Content-Type: application/json" \-d '{"CHAT_TYPE":"MemoChat","HASH_CHAT_ID": "${HASH_CHAT_ID}","TEMPLATE_ID": 10000,"IS_SINGLE_CHATROOM": false,"CHAT_MEMBER_COUNT_RANGE": "1+","custom_parameter_key": "custom_parameter_value"}'