사이드 메뉴
커뮤니케이션
API 제공
어드민 API
카카오톡 채널
웹훅
이 문서는 카카오 또는 공동체 서비스용 카카오톡 채널 관련 웹훅 정보를 안내합니다.
이용 정책에서 웹훅 사용 시 주의 사항을 확인해야 합니다.
카카오톡 채널 웹훅은 사용자가 앱에 연결된 카카오톡 채널을 추가하거나 차단한 경우, 카카오가 해당 사실을 서비스로 전달하는 기능입니다. 웹훅을 수신한 서비스는 HTTP 상태 코드 2XX로 3초 내에 응답해야 합니다.
카카오톡 채널 웹훅은 웹훅 URL을 지정해야 사용할 수 있으며, 리다이렉트는 지원하지 않습니다. 설정 방법은 카카오톡 채널 웹훅을 참고합니다.
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| 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 |
Inhouse
: 카카오 및 공동체 서비스의 앱에만 전달하는 필드
| 이름 | 타입 | 설명 |
|---|---|---|
| event | String | 사용자와 카카오톡 채널의 관계 변경 사항, 추가(added) 또는 차단(blocked) |
| id | String | 카카오톡 채널 추가 또는 차단한 사용자 식별자 |
| id_type | String | 식별자 타입, app_user_id 또는 open_idapp_user_id: 카카오 로그인 동의항목 중 [카카오톡 채널 추가 상태 및 내역]을 제공 동의한 사용자open_id: [카카오톡 채널 추가 상태 및 내역] 항목에 제공 동의하지 않은 사용자 |
| account_id Inhouse | Long | 사용자의 카카오계정 ID 제공 조건: 카카오계정 ID 응답 권한 보유 |
| channel_public_id | String | 사용자와 카카오톡 채널의 관계가 변경된 카카오톡 채널의 프로필 ID 참고: 카카오톡 채널 프로필 ID 확인 방법 |
| channel_uuid | String | 카카오톡 채널의 검색용 ID |
| updated_at | Datetime | 카카오톡 채널 관계가 변경된 시간, UTC (RFC3339 internet date/time format) |
- HTTP 상태 코드
2XX(3초 내)
요청
curl -X POST "${KAKAOTALK_CHANNEL_CALLBACK_URL}" \-H "Authorization: KakaoAK ${PRIMARY_ADMIN_KEY}" \-H "Content-Type: application/json" \-d '{"event":"added","id":"1111","id_type":"app_user_id","account_id":1234567, // 권한 필요"channel_public_id":"_FLX", // 추가"channel_uuid":"@ad", // 추가"plus_friend_public_id":"_FLX", // deprecated"plus_friend_uuid":"@ad", // deprecated"timestamp":1574331247000, // deprecated"updated_at":"2019-11-21T10:14:07Z"}'