English한국어

레거시

이 문서에서는 더 이상 지원하지 않거나, 곧 지원이 중단되는 SDK에 대해 설명합니다.

❗️

이 문서에 기재된 레거시 SDK는 사용하지 않을 것을 권장합니다.

레거시 SDK는 언제든지 지원 중단될 수 있으며, 이로 인해 에러가 발생할 수 있습니다.
만약 이미 사용 중인 SDK가 있다면, 해당 SDK의 마이그레이션 가이드를 통해 빠른 시일 내에 교체할 것을 권장합니다.

ChannelIO

show

메신저를 엽니다.

ChannelIO('show');

📘

마이그레이션 가이드

showMessenger를 사용합니다.

hide

메신저를 닫습니다.

ChannelIO('hide');

📘

마이그레이션 가이드

hideMessenger를 사용합니다.

lounge

홈으로 이동합니다.

ChannelIO('lounge');

openSupportBot

🚧

해당 API는 Deprecated 되었습니다. openWorkflow API를 사용해주세요.

서포트봇에 대한 지원 종료로 인해 해당 API는 Deprecated 되었으며, 해당 API는 openWorkflow SDK API와 같은 동작을 수행하게 됩니다. message 인자는 무시됩니다.

유저챗을 열며 특정 서포트봇을 실행합니다.

supportBotId 인자로 전달한 값에 대응하는 서포트봇이 존재하면 해당 서포트봇이 실행됩니다. 만약 supportBotId를 전달하지 않으면 아무런 동작이 수행되지 않습니다. 전달한 supportBotId에 대응하는 서포트봇이 존재하지 않으면 에러페이지가 보여집니다.

message 인자를 전달하면 서포트봇이 완료된 후에 입력창에 입력됩니다.

동작supportBotIdmessage비고
특정 서포트봇을 실행합니다stringundefinedsupportBotId 가 유효하지 않을 경우, 에러페이지가 보여집니다.
특정 서포트봇을 실행하며 완료된 후 입력창에 메세지가 입력됩니다stringstringsupportBotId 가 유효하지 않을 경우, 에러페이지가 보여집니다.
ChannelIO('openSupportBot', supportBotId: string, message?: string)
매개변수타입설명
supportBotIdstring서포트봇의 id.
message(optional) string서포트봇이 완료된 후 메시지 입력창에 들어갈 문자열.
// id가 '123'인 서포트봇이 존재할 경우, 해당 서포트봇이 실행됩니다.
// 만약 존재하지 않을 경우, 에러페이지가 보여집니다.
ChannelIO('openSupportBot', '123');

// id가 '123'인 서포트봇이 존재할 경우, 해당 서포트봇이 실행됩니다.
// 만약 존재하지 않을 경우, 에러페이지가 보여집니다.
// 서포트봇이 완료된 후 메시지 입력창에 'Text here'가 입력됩니다.
ChannelIO('openSupportBot', '123', 'Text here');

onBoot

부트가 완료되었을 때 호출될 콜백 함수를 등록합니다.
부트가 성공하면 콜백 함수의 인자로 유저 객체를 전달합니다. 부트가 실패하면 콜백 함수의 인자로 undefined를 전달합니다.

ChannelIO('onBoot', function(user) {
  // YOUR CODE...
});

📘

마이그레이션 가이드

boot의 callback 매개변수를 사용합니다.

onShow

메신저가 열릴 때 호출될 콜백 함수를 등록합니다.

ChannelIO('onShow', function() {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onShowMessenger를 사용합니다.

onHide

메신저가 닫힐 때 호출될 콜백 함수를 등록합니다.

ChannelIO('onHide', function() {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onHideMessenger를 사용합니다.

onChangeBadge

유저가 아직 읽지 않은 메시지의 수가 바뀔 때 실행될 콜백 함수를 등록합니다.

ChannelIO('onChangeBadge', function(unreadCount) {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onBadgeChanged를 사용합니다.

onCreateChat

유저챗이 생성되었을 때 실행될 콜백 함수를 등록합니다.

ChannelIO('onCreateChat', function() {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onChatCreated를 사용합니다.

onProfileChanged

유저가 프로필을 변경했을 때 실행될 콜백 함수를 등록합니다.
콜백 함수의 인자로 전달되는 profile 객체는 아래 필드로 구성되어 있습니다.

  • name: 유저의 이름
  • email: 유저의 이메일
  • mobileNumber: 유저의 핸드폰 번호
ChannelIO('onProfileChanged', function(profile) {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onFollowUpChanged를 사용합니다.

onChangeProfile

유저가 프로필을 변경했을 때 실행될 콜백 함수를 등록합니다.
콜백 함수의 인자로 전달되는 profile 객체는 아래 필드로 구성되어 있습니다.

  • name: 유저의 이름
  • email: 유저의 이메일
  • mobileNumber: 유저의 핸드폰 번호
ChannelIO('onChangeProfile', function(profile) {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onFollowUpChanged를 사용합니다.

onClickRedirect

유저가 링크를 클릭했을 때 실행될 콜백 함수를 등록합니다.
채널톡에서 유저가 클릭할 수 있는 링크는 아래와 같습니다.

  • 마케팅 팝업의 링크 버튼/텍스트
  • 유저챗에서 매니저가 보낸 메시지의 링크 버튼/텍스트
ChannelIO('onUrlClicked', function(url) {
  // YOUR CODE...
});

📘

마이그레이션 가이드

onUrlClicked를 사용합니다.

Boot Option

hideDefaultLauncher

기본 채널 버튼을 숨길지 여부를 설정합니다.

📘

마이그레이션 가이드

hideChannelButtonOnBoot를 사용합니다.

locale

기본 언어를 설정합니다.

📘

마이그레이션 가이드

language를 사용합니다.

enabledTrackDefaultEvent

기본 이벤트(PageView)를 트래킹할지 여부를 설정합니다.

📘

마이그레이션 가이드

trackDefaultEvent를 사용합니다.

enabledUtmSourceTrack

UTM source와 referrer를 트래킹할지 여부를 설정합니다.

📘

마이그레이션 가이드

trackUtmSource를 사용합니다.