Flutter

이 문서는 Kakao SDK for Flutter(이하 Flutter SDK)를 사용한 카카오톡 채널 기능 구현 방법을 안내합니다.

시작하기 전에

카카오톡 채널 추가 구현 방식 선택

카카오톡 채널 추가 방식은 카카오톡 채널 간편 추가하기와 카카오톡 채널 추가하기 두 가지입니다. 서비스 페이지 내에서 바로 채널 추가를 요청할 수 있고, 별도의 확인 절차 없이 응답으로 결과를 확인할 수 있는 카카오톡 채널 간편 추가하기 사용을 권장합니다.

카카오톡 채널 추가를 참고해 어떤 방식을 사용할지 결정합니다.

커스텀 URL 스킴 설정

카카오톡 채널 간편 추가하기를 사용하려면, AndroidManifest.xml에 커스텀 URL 스킴(Custom URL Scheme)을 설정해야 합니다. 커스텀 URL 스킴은 기본 브라우저의 채널 추가 동작 후 서비스 앱으로 전환에 필요합니다. 아래 예제를 참고합니다.

<!-- Flutter 프로젝트의 Android 환경 카카오톡 채널 간편 추가하기 커스텀 URL 스킴 설정 -->
<activity 
    android:name="com.kakao.sdk.flutter.FollowChannelHandlerActivity"
    android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- Redirect URI: "kakao${NATIVE_APP_KEY}://channel" -->
        <data android:scheme="kakao${YOUR_NATIVE_APP_KEY}" android:host="channel"/>
    </intent-filter>
    </intent-filter>
</activity>

카카오톡 채널 간편 추가하기

기본 정보

레퍼런스	앱 설정
FollowChannelResult followChannel()	설치 초기화 커스텀 URL 스킴 설정

권한	사전 설정	카카오 로그인	동의항목
-	플랫폼 등록 카카오 로그인 활성화 동의항목 비즈니스 채널 연결	-	-

사용자에게 지정된 카카오톡 채널의 친구 추가를 요청합니다. 서비스 내에서 요청 화면을 표시하고 응답으로 결과를 전달받을 수 있습니다.

요청

TalkApi의 followChannel()로 요청합니다. 카카오톡 채널 프로필 ID를 전달해야 합니다. 서비스의 카카오 로그인 사용 여부에 따른 채널 추가 요청 처리 방법은 카카오 로그인 사용 서비스와 카카오 로그인 미사용 서비스를 참고합니다.

응답

요청 성공 시 응답으로 받는 FollowChannelResult 객체는 카카오톡 채널 프로필 ID와 요청 결과를 포함합니다. 요청 실패 또는 문제 발생 시 문제 해결에서 원인을 확인합니다.

예제

try {
  // 카카오톡 채널 간편 추가하기
  await TalkApi.instance.followChannel("${CHANNEL_PUBLIC_ID}");
  print("성공")
  // 채널 간편 추가 성공 처리
} catch(error) {
  Log.e(context, tag, "실패", error);
  // 채널 간편 추가 실패 처리
}

카카오톡 채널 추가하기

기본 정보

레퍼런스	앱 설정
addChannel() addChannelUrl()	설치 초기화

권한	사전 설정	카카오 로그인	동의항목
-	플랫폼 등록	-	-

사용자가 카카오톡 채널을 친구 추가하러 이동합니다.

요청

TalkApi의 addChannel()을 호출합니다. 카카오톡 채널의 프로필 ID를 전달해야 합니다.

응답

카카오톡 채널 추가 여부는 이 API 호출 결과로 알 수 없습니다. 카카오톡 채널 관계 확인하기 API로 사용자와 카카오톡 채널의 관계를 조회해야 추가 또는 삭제 상태를 알 수 있습니다.

카카오톡 채널 간편 추가하기를 사용하면 서비스 페이지 내에서 바로 채널 추가를 요청하고 별도의 확인 절차 없이 응답으로 결과를 확인할 수 있습니다.

예제

try {
  // 카카오톡 채널 추가하기
  await TalkApi.instance.addChannel("${CHANNEL_ID}");
} catch(e) {
  Log.e(context, tag, "채널 추가 실패", e);
}

추가 기능

연결 페이지

카카오톡 채널로 즉시 이동하지 않고, 필요한 시점에 연결 페이지를 거쳐 이동하도록 할 수 있습니다. addChannelUrl()로 연결 페이지 URL을 요청합니다. 카카오톡 채널의 프로필 ID를 전달해야 합니다. 연결 페이지 URL은 launchBrowserTab() 메서드를 통해 기본 브라우저에서 열 수 있습니다.

// 연결 페이지 URL 구하기
Uri url = await TalkApi.instance.addChannelUrl("_ZeUTxl");

// 연결 페이지 URL을 브라우저에서 열기
try {
  await launchBrowserTab(url);
} catch (error) {
  print("카카오톡 채널 추가 실패 $error");
}

카카오톡 채널 채팅하기

기본 정보

레퍼런스	앱 설정
chatChannel() chatChannelUrl()	설치 초기화

권한	사전 설정	카카오 로그인	동의항목
-	플랫폼 등록	-	-

사용자가 서비스의 카카오톡 채널과 1:1 채팅을 시작합니다.

요청

TalkApi의 chatChannel()을 호출합니다. 카카오톡 채널의 프로필 ID를 전달해야 합니다.

응답

이 함수의 호출 결과는 사용자가 성공적으로 채팅방에 진입했는지 여부를 알려주지 않습니다.

예제

try {
  // 카카오톡 채널 채팅하기
  await TalkApi.instance.chatChannel("${CHANNEL_ID}");
} catch(e) {
  Log.e(context, tag, "채널 채팅 실패", e);
}

추가 기능

연결 페이지

카카오톡 채널로 즉시 이동하지 않고, 필요한 시점에 연결 페이지를 거쳐 이동하도록 할 수 있습니다. chatChannelUrl()로 연결 페이지 URL을 요청합니다. 카카오톡 채널의 프로필 ID를 전달해야 합니다. 연결 페이지 URL은 launchBrowserTab() 메서드를 통해 기본 브라우저에서 열 수 있습니다.

// 카카오톡 채널 채팅 URL
Uri url = await TalkApi.instance.chatChannelUrl("_ZeUTxl");

// 디바이스 브라우저 열기
try {
  await launchBrowserTab(url);
} catch (error) {
  print("카카오톡 채널 채팅 실패 $error");
}

참고: 안내 메시지

연결 페이지가 실행되었을 때, 해당 카카오톡 채널은 사용자에게 "안녕하세요, 무엇을 도와드릴까요?"라는 문구와 함께 사용자가 채팅을 요청했던 연결 페이지 URL을 담은 안내 메시지를 전송합니다.

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

기본 정보

레퍼런스	앱 설정
channels() Channels	설치 초기화

권한	사전 설정	카카오 로그인	동의항목
-	플랫폼 등록 카카오 로그인 활성화 동의항목 카카오톡 채널 연결	필요	필요: 카카오톡 채널 추가 상태 및 내역

현재 로그인한 사용자와 앱에 연결된 카카오톡 채널의 친구 관계를 확인합니다.

요청

TalkApi의 channels()를 호출합니다. 특정 카카오톡 채널과의 관계만 확인하려면 publicIds 파라미터로 조회 대상 카카오톡 채널의 프로필 ID 리스트를 전달합니다.

응답

요청 성공 시 Channels 객체를 받습니다. 각 카카오톡 채널과 사용자의 친구 관계는 Channels 하위의 Channel에 포함된 relation 값으로 확인할 수 있습니다.

• ADDED: 카카오톡 채널이 추가된 상태
• BLOCKED: 카카오톡 채널이 차단된 상태
• NONE: 카카오톡 채널이 추가되거나 차단된 적 없는 상태

이 외 자세한 응답 정보는 REST API를 참고합니다.

예제

try {
  Channels relations = await TalkApi.instance.channels();
  print("채널 관계 확인 성공"
        "\n${relations.channels}");
} catch (error) {
  print("채널 관계 확인 실패 $error");
}