페이지 이동경로
  • 문서>
  • 카카오톡 채널

카카오톡 채널

REST API

이 문서는 기존 버전의 카카오톡 채널 관계 확인하기 REST API 사용 방법을 안내합니다.

카카오톡 채널 관계 확인하기

동의 항목 설정 필요

이 API를 사용하려면 동의 항목 설정을 참고하여 [카카오톡 채널 추가 상태 및 내역] 동의 항목을 설정해야 합니다. 동의 항목이 설정되어 있더라도 사용자가 동의하지 않으면 [카카오톡 채널 추가 상태 및 내역]을 받을 수 없습니다. 동의 내역 확인하기 API를 통해 사용자가 동의한 동의 항목을 먼저 확인할 수 있습니다.

신규 API 제공 안내

이 API는 동일한 기능의 신규 API를 제공합니다. 기존 API의 제공이 추후 중단될 수 있으므로, 가급적 신규 API를 사용할 것을 권장합니다. 자세한 사항은 데브톡 공지사항과 신규 API 카카오톡 채널 관계 확인하기를 참고합니다.

특정 사용자와 카카오톡 채널의 관계를 확인합니다. 이 API를 사용하기 전 카카오톡 채널을 참고하여 애플리케이션(이하 앱)과 카카오톡 채널을 연결하고 [카카오톡 채널 추가 상태 및 내역] 동의 항목을 설정해야 합니다.

사용자 액세스 토큰(Access Token)을 헤더에 담아 GET으로 요청합니다. 서비스 서버에서 관리자가 요청할 경우, 앱별 어드민 키(Admin Key)로 특정 사용자의 카카오톡 채널 관계를 확인할 수 있습니다. 어드민 키는 보안에 유의해야 하므로 서버에서의 호출 시에만 사용해야 합니다.

응답은 JSON 형식이며 사용자가 추가 또는 차단한 카카오톡 채널 중, 서비스 앱과 연결된 카카오톡 채널에 한해 정보를 제공합니다. 응답의 각 카카오톡 채널 정보는 사용자와 카카오톡 채널의 현재 추가 상태, 변경 시점과 같은 자세한 정보를 포함합니다.

사용자가 [카카오톡 채널 추가 상태 및 내역] 동의 항목에 동의하지 않아 에러 응답을 받았을 경우, 추가 항목 동의 받기 기능을 사용해 사용자에게 다시 동의를 요청할 수 있습니다.

Request

Access Token 사용

URL
GET /v1/api/talk/plusfriends HTTP/1.1
Host: kapi.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name Description Required
Authorization 사용자 인증 수단, 액세스 토큰 값
Authorization: Bearer ${ACCESS_TOKEN}
O

Admin Key 사용

URL
GET /v1/api/talk/plusfriends HTTP/1.1
Host: kapi.kakao.com
Authorization: KakaoAK ${APP_ADMIN_KEY}
Content-type: application/x-www-form-urlencoded;charset=utf-8
Header
Name Description Required
Authorization 사용자 인증 수단, 앱 어드민 키
Authorization: KakaoAK ${APP_ADMIN_KEY}
O
Parameter
Name Description Required
target_id_type 사용자 ID 타입, user_id로 고정 O
target_id 회원번호 O
Response
Key
Name Type Description Required
user_id Long 회원번호 O
plus_friends PlusFriendInfo[] 카카오톡 채널 정보 X
PlusFriendInfo
Name Type Description Required
plus_friend_public_id String 카카오톡 채널 프로필 ID
채널 URL에서 https://pf.kakao.com/ 부분을 제외한 뒷자리 값
예) 채널 URL이 https://pf.kakao.com/_ZeUTxl인 경우, 카카오톡 채널의 프로필 ID는 _ZeUTxl
O
relation String 카카오톡 채널과 사용자 관계
ADDED: 카카오톡 채널이 추가된 상태
BLOCKED: 카카오톡 채널이 차단된 상태
NONE: 카카오톡 채널이 추가되거나 차단된 적 없는 상태
O
updated_at Datetime 카카오톡 채널 상태 변경 시간, UTC*
카카오톡 채널이 추가(ADDED) 또는 차단(BLOCKED)된 상태일 경우만 포함
X

* UTC: 한국 시간(KST)과 9시간 차이, RFC3339: Date and Time on the Internet 참고

Sample
Request: 액세스 토큰 사용
curl -v -X GET "https://kapi.kakao.com/v1/api/talk/plusfriends" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
Request: 어드민 키 사용
curl -v -G GET "https://kapi.kakao.com/v1/api/talk/plusfriends" \
-H "Authorization: KakaoAK ${APP_ADMIN_KEY}" \
-d "target_id_type=user_id" \
-d "target_id=${USER_ID}"
Response: 성공
HTTP/1.1 200 OK
{
 "user_id": 1111111
 "plus_friends": [
  {
   "plus_friend_public_id": "_aTSxexl",
   "plus_friend_uuid": "@테스트",
   "relation": "ADDED",
   "updated_at": "2019-05-10T08:06:53Z"
  }
 ]
}
Response: 실패, 카카오톡 미사용자를 대상으로 요청한 경우
HTTP/1.1 400 Bad Request
{
    "msg": "given account is not connected to any talk user.",
    "code": -501
}

더보기