This document describes the v1 version of the Checking Kakao Talk Channel relationship API.

This API enables you to check if a specific user has added or blocked your Kakao Talk Channel connected to your service app.

Make sure that this API only informs the relationship between the user and the Kakao Talk Channel connected to the app that made a request. Thus, you cannot get all Kakao Talk Channels' information that the user has added but the channels related to your service only.

If you are an administrator, you can also use the app's Admin key to check the relationship between a Kakao Talk Channel and a specific user. When requesting using the app's Admin key and a service user ID, make a request from the service server by referring to the code snippet and parameters as follows. Make sure to use the app's Admin key only in the server.

Among Kakao Talk Channels that a user has added or blocked, only the channels connected to your service app return in the response in JSON format. Each channel object in the response contains detailed information, such as whether the user adds or blocks the Kakao Talk Channel currently and the time when the channel has been added or blocked.

In the following situations, permission-related error occurs:

• If you set 'Kakao Talk Channel addition status and details' to 'Optional item', a user may not consent to the consent item. In this case, you can request consent from the user again by Requesting additional consent as needed.

curl -v -G GET "https://kapi.kakao.com/v1/api/talk/channels" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  --data-urlencode 'channel_public_ids=["_frxjem","_xnrxjem","_Brxjem"]'

curl -v -G GET "https://kapi.kakao.com/v1/api/talk/channels" \
  -H "Authorization: KakaoAK ${SERVICE_APP_ADMIN_KEY}" \
  -d "target_id_type=user_id" \
  -d "target_id={USER_ID}" \
  --data-urlencode 'channel_public_ids=["_frxjem","_xnrxjem","_Brxjem"]'

HTTP/1.1 200 OK
{
  "user_id": 1111111,
  "channels": [
    {
      "channel_uuid": "@테스트",
      "channel_public_id": "_ZeUTxl",
      "relation": "ADDED", // One of ADDED, BLOCKED, NONE
      "created_at": "2020-04-18T03:17:05Z", // Only returned when "relation" is "ADDED".
      "updated_at": "2021-05-17T05:25:01Z"
    }, // Only returned when "relation" is "ADDED" or "BLOCKED".
    ...
  ]
}

HTTP/1.1 400 Bad Request
{
    "msg": "given account is not connected to any talk user.",
    "code": -501
}