Channel Developers

Introduction

App

SDK導入ガイド

SDK - JavaScript

SDK - iOS

SDK - Android

SDK - React Native

Open API

Webhook

Snippet

Open API for Documents

FrontALF

Legacy

このドキュメントでは、すでにサポートされていない、または間もなくサポートが終了するSDKについて説明します。

この文書に記載されたLegacy SDKは使用しないことを推奨します。

Legacy SDKはサポートが中断される可能性があり、それによりエラーが発生する場合があります。もし既に使用中のSDKがある場合は、該当するSDKのマイグレーションガイドを参照し、速やかに交換することを推奨します。

ChannelIO

show

メッセンジャーを開きます。

JavaScript

マイグレーションガイド

showMessengerを使用します。

hide

メッセンジャーを閉じます。

JavaScript

マイグレーションガイド

hideMessengerを使用します。

lounge

ホームへ移動します。

JavaScript

openSupportBot

該当のAPIは廃止になりました。openWorkflow APIをご使用ください。

サポートボットのサポート終了に伴い、該当のAPIは非推奨となり、openWorkflow SDK APIと同じ動作を実行するようになります。message引数は無視されます。

ユーザーチャットを開き、特定のサポートボットを実行します。

supportBotId引数で渡した値に対応するサポートボットが存在する場合、そのサポートボットが実行されます。もしsupportBotIdを渡さない場合は、何の動作も行われません。渡されたsupportBotIdに対応するサポートボットが存在しない場合は、エラーページが表示されます。message引数を渡すと、サポートボットが完了した後に入力欄へ入力されます。

アクション	`supportBotId`	`message`	備考
特定のサポートボットを実行します。	`string`	`undefined`	`supportBotId`が有効でない場合、エラーページが表示されます。
特定のサポートボットを実行し、完了後に入力欄にメッセージが入力されます。	`string`	`string`	`supportBotId`が有効でない場合、エラーページが表示されます。

JavaScript

パラメータ	タイプ	説明
supportBotId	`string`	サポートボットのID
message	(optional) `string`	サポートボットが完了した後、メッセージ入力欄に入る文字列。

JavaScript

onBoot

bootが完了したときに呼び出されるコールバック関数を登録します。

ブートに成功すると、コールバック関数の引数としてUser objectを渡します。bootに失敗すると、コールバック関数の引数としてundefinedを渡します。

JavaScript

マイグレーションガイド

bootのcallbackパラメータを使用します。

onShow

メッセンジャーが開いたときに呼び出されるコールバック関数を登録します。

JavaScript

マイグレーションガイド

onShowMessengerを使用します。

onHide

メッセンジャーが閉じられたときに呼び出されるコールバック関数を登録します。

JavaScript

マイグレーションガイド

onHideMessengerを使用します。

onChangeBadge

ユーザーがまだ読んでいないメッセージの数が変わったときに実行されるコールバック関数を登録します。

JavaScript

マイグレーションガイド

onBadgeChangedを使用します。

onCreateChat

ユーザーチャットが生成されたときに実行されるコールバック関数を登録します。

JavaScript

マイグレーションガイド

onChatCreatedを使用します。

onProfileChanged

ユーザーがプロフィールを変更したときに実行されるコールバック関数を登録します。

コールバック関数の引数として渡されるprofileオブジェクトは、以下のフィールドで構成されています。

name：ユーザーの名前
email：ユーザーのメールアドレス
mobileNumber：ユーザーの携帯電話番号

JavaScript

マイグレーションガイド

onFollowUpChangedを使用します。

onChangeProfile

ユーザーがプロフィールを変更したときに実行されるコールバック関数を登録します。

コールバック関数の引数として渡されるprofileオブジェクトは、以下のフィールドで構成されています。

name：ユーザーの名前
email：ユーザーのメールアドレス
mobileNumber：ユーザーの携帯電話番号

JavaScript

マイグレーションガイド

onFollowUpChangedを使用します。

onClickRedirect

ユーザーがリンクをクリックしたときに実行されるコールバック関数を登録します。

チャネルトークでユーザーがクリックできるリンクは以下の通りです。

マーケティングポップアップのリンクボタン/テキスト
ユーザーチャットでチームメンバーが送信したメッセージのリンクボタン/テキスト

JavaScript

マイグレーションガイド

onUrlClickedを使用します。

Boot Option

hideDefaultLauncher

基本のチャネルボタンを非表示にするかどうかを設定します。

マイグレーションガイド

hideChannelButtonOnBootを使用します。

locale

基本言語を設定します。

マイグレーションガイド

languageを使用します。

enabledTrackDefaultEvent

デフォルトイベント（PageView）をトラッキングするかどうかを設定します。

マイグレーションガイド

trackDefaultEventを使用します。

enabledUtmSourceTrack

UTMソースとリファラーをトラッキングするかどうかを設定します。

マイグレーションガイド

trackUtmSourceを使用します。