ChannelIO

boot

SDKの初期化を行います。

チャネルボタンが表示され、マーケティングポップアップなどの機能が利用可能な状態になります。詳細については、bootをご参照ください。

JavaScript

パラメータ	タイプ	説明
bootOption	`object`	SDKを初期化するためのBoot Option
callback	(optional) `Function`	bootの後に実行されるコールバック関数。 bootに失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数としてnullを受け取ります。 bootに成功した場合、コールバックは第1引数としてnullを、第2引数としてUser Objectを受け取ります。

パラメータ

タイプ

説明

bootOption

object

SDKを初期化するためのBoot Option

callback

(optional) Function

bootの後に実行されるコールバック関数。

bootに失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数としてnullを受け取ります。

bootに成功した場合、コールバックは第1引数としてnullを、第2引数としてUser Objectを受け取ります。

JavaScript

shutdown

SDKのすべての動作を停止し、内部データを初期化します。

JavaScript

showMessenger

メッセンジャーを表示します。

JavaScript

hideMessenger

メッセンジャーを非表示にします。

JavaScript

openChat

チャットを開きます。

chatId が未定義（undefined）の場合、新しいチャットが開かれます。message引数が指定されている場合、それは入力フィールドに表示されます。ワークフローがアクティブな場合、それがトリガーされます。
chatIdに対応するチャットが存在する場合、そのチャットが開かれ、message引数は無視されます。チャットが存在しない場合、エラーページが表示されます。

アクション	`chatId`	`message`	備考
新しいチャットを開きます。	`undefined`	`undefined`	ワークフローがアクティブな場合、トリガーされます。
メッセージ付きで新しいチャットを開きます。	`undefined`	`string`	ワークフローがアクティブな場合、トリガーされます。メッセージはワークフローの動作後、入力フィールドに表示されます。
特定のチャットを開きます。	`string`	`undefined`	チャットが存在しない場合、エラーページが表示されます。

アクション

chatId

message

備考

新しいチャットを開きます。

undefined

ワークフローがアクティブな場合、トリガーされます。

メッセージ付きで新しいチャットを開きます。

undefined

string

ワークフローがアクティブな場合、トリガーされます。

メッセージはワークフローの動作後、入力フィールドに表示されます。

特定のチャットを開きます。

string

undefined

チャットが存在しない場合、エラーページが表示されます。

パラメータ	タイプ	説明
chatId	(optional) `string`	チャットのID
message	(optional) `string`	新しいチャットが開かれた際に、入力フィールドに入力されるメッセージ

JavaScript

openWorkflow

接客チャットを開き、指定されたワークフローを開始します。

openWorkflow は、ワークフローのトリガーが「チャネルトークを介してチャットを開始したとき」に設定されている場合にのみ実行できます。
提供された workflowIdに対応するワークフローが存在する場合、それが実行されます。workflowId が無効な場合、エラーページが表示されます。
workflowIdを渡さない場合、何の操作も行われません。

JavaScript

パラメータ	タイプ	説明
workflowId	`string`	開始するワークフローのID。該当するワークフローが存在しない場合、エラーページが表示されます。

JavaScript

track

イベントをトラック（追跡）します。

これまでに作成されたことのない新しいイベントをトラックした場合、そのイベントが新規作成されます。
管理画面でイベントを確認できるようになるまで、数分から数時間かかる場合があります。

JavaScript

パラメータ	タイプ	説明
eventName	`string`	イベントの名前。最大64文字まで入力可能です。
eventProperty	(optional)`object`	イベントのプロパティ

JavaScript

onShowMessenger

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

JavaScript

パラメータ	タイプ	説明
callback	`Function`	メッセンジャーが表示されたときに呼び出されるコールバック関数

JavaScript

onHideMessenger

メッセンジャーが非表示になったときに呼び出されるコールバックを登録します。

JavaScript

パラメータ	タイプ	説明
callback	`Function`	メッセンジャーが非表示になったときに呼び出されるコールバック関数

JavaScript

onBadgeChanged

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

JavaScript

パラメータ	タイプ	説明
callback	`Function`	ユーザーがまだ読んでいないメッセージの数に変化があったときに呼び出されるコールバック関数。このコールバックは2つの引数を受け取ります：`unread`（チャネルボタン上に赤点で表示される未読通知の総数）と、`alert`（チャネルボタン上に数字で表示される重要な未読通知の数）です。

パラメータ

タイプ

説明

callback

Function

ユーザーがまだ読んでいないメッセージの数に変化があったときに呼び出されるコールバック関数。

このコールバックは2つの引数を受け取ります：unread（チャネルボタン上に赤点で表示される未読通知の総数）と、alert（チャネルボタン上に数字で表示される重要な未読通知の数）です。

JavaScript

onChatCreated

チャットが作成されたときに呼び出されるコールバックを登録します。

JavaScript

パラメータ	タイプ	説明
callback	`Function`	新しいチャットが作成されたときに呼び出されるコールバック関数

JavaScript

onFollowUpChanged

ユーザーのプロフィールに変更があったときに呼び出されるコールバックを登録します。

JavaScript

パラメータ	タイプ	説明
callback	`Function`	ユーザーのプロフィールが更新されたときに呼び出されるコールバック関数。このコールバックは、引数として更新後のプロフィールオブジェクトを受け取ります。

パラメータ

タイプ

説明

callback

Function

ユーザーのプロフィールが更新されたときに呼び出されるコールバック関数。

このコールバックは、引数として更新後のプロフィールオブジェクトを受け取ります。

プロフィールオブジェクトには、以下のフィールドが含まれます。

パラメータ	タイプ	説明
`name`	(optional) `string` \| `null`	ユーザーの名前
`email`	(optional) `string` \| `null`	ユーザーのメールアドレス
`mobileNumber`	(optional) `string` \| `null`	ユーザーの携帯電話番号。E.164形式に準拠します。

JavaScript

onUrlClicked

ユーザーがリンクをクリックしたときに呼び出されるコールバックを登録します。これには、以下のリンク先への遷移が含まれます。

マーケティングポップアップ内のリンクボタンまたはリンクテキスト
チャット内でマネージャーまたはユーザーから送信されたリンクボタンまたはリンクテキスト

JavaScript

パラメータ	タイプ	説明
callback	`Function`	ユーザーがリンクをクリックしたときに呼び出されるコールバック関数。このコールバックは、引数としてクリックされたリンクのURLを受け取ります。

パラメータ

タイプ

説明

callback

Function

ユーザーがリンクをクリックしたときに呼び出されるコールバック関数。

このコールバックは、引数としてクリックされたリンクのURLを受け取ります。

onPopupDataReceived

ポップアップ（および吹き出し）が表示されたときに実行されるコールバック関数を登録します。

ポップアップ（および吹き出し）は、以下のような場合に表示されます。

チームメンバーからメッセージを受信したとき
ユーザーがマーケティングポップアップを受信したとき

JavaScript

パラメータ	タイプ	説明
callback	`Function`	メッセージバブルが表示されたときに実行されるコールバック関数。パラメータとして、ポップアップに関する情報データオブジェクトを受け取ります。

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

プロパティ	タイプ	説明
`avatarUrl`	`string`	メッセージ送信者のプロフィール画像のURL
`chatId`	`string`	メッセージに対応するユーザーチャットのID
`message`	(optional) `string` \| `null`	メッセージの内容
`name`	`string`	メッセージ送信者の名前
`timestamp`	`number`	メッセージが送信された時刻のUnixタイムスタンプ

JavaScript

clearCallbacks

以下のAPIによって登録されたすべてのコールバックを解除します。

JavaScript

updateUser

ユーザーの情報を更新します。

JavaScript

パラメータ	タイプ	説明
userObject	`object`	更新されるユーザー情報を含むオブジェクト
callback	(optional) `Function`	更新後に呼び出されるコールバック関数。更新が失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数として `null` を受け取ります。更新が成功した場合、コールバックは第1引数として null を、第2引数として更新されたユーザーオブジェクトを受け取ります。

パラメータ

タイプ

説明

userObject

object

更新されるユーザー情報を含むオブジェクト

callback

(optional) Function

更新後に呼び出されるコールバック関数。

更新が失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数として null を受け取ります。更新が成功した場合、コールバックは第1引数として null を、第2引数として更新されたユーザーオブジェクトを受け取ります。

ユーザー情報を更新するために、以下のフィールドを設定できます。

フィールド	タイプ	説明
language	(optional)`string`	ユーザーの言語を設定します。`言語`が`'ko'`または`'ja'`の場合、UIテキストは指定された言語に変更されます。それ以外の場合、UIテキストはデフォルトで英語になります。
profile	(optional)`object` \|`null`	ユーザーのプロフィールを設定します。nullを渡すとプロフィール全体がリセットされます。プロフィールオブジェクト内の特定のフィールドをリセットするには、そのフィールドにnullを渡してください。空のオブジェクトは許可されず、フィールド名はキャメルケース（Camel Case）に従う必要があります。`mobileNumber` については、E.164形式に従ってください。
profileOnce	(optional) `object`	既存の値がないフィールドに限定して、ユーザーのプロフィールを設定します。
tags	(optional) `array`\\|`null`	ユーザーのタグを設定します。最大10個まで許可されます。`null` を渡すとすべてのタグがリセットされます。空の配列は許可されません。
unsubscribeEmail	(optional) `boolean`	ユーザーがマーケティングメールを購読しているかどうかを設定します。`true` に設定すると、購読が解除（停止）されます。
unsubscribeTexting	(optional) `boolean`	ユーザーがマーケティングSMSを購読しているかどうかを設定します。`true` に設定すると、購読が解除（停止）されます。

JavaScript

addTags

ユーザーのタグを追加します。

JavaScript

パラメータ	タイプ	説明
tags	`string[]`	追加するタグの配列。最大10個まで許可されます。タグは常に小文字で保持されます。
callback	(optional) `Function`	タグ追加後に呼び出されるコールバック関数。追加が失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数として null を受け取ります。追加が成功した場合、コールバックは第1引数として null を、第2引数として更新されたユーザーオブジェクトを受け取ります。

JavaScript

removeTags

ユーザーのタグを削除します。

JavaScript

パラメータ	タイプ	説明
tags	`string[]`	削除するタグの配列。対応するタグが存在しない場合は無視されます。`null` または空の配列を渡すことは許可されません。
callback	(optional) `Function`	タグ削除後に呼び出されるコールバック関数。削除が失敗した場合、コールバックは第1引数としてエラーオブジェクトを、第2引数として null を受け取ります。削除が成功した場合、コールバックは第1引数として null を、第2引数として更新されたUser Objectを受け取ります。

JavaScript

setPage

ユーザーのチャットプロフィールとともにPageを設定します。ページはCanonical URLの代わりに使用できます。

pageにnullまたはundefinedを渡さないでください

profile パラメータにシリアライズ不可能な値（例：関数オブジェクト）が含まれている場合、それらの値は無視されます。

JavaScript

パラメータ	タイプ	説明
page	`string`	設定するページの値
profile	(optional) `Record<string, any>`	ユーザーチャットプロフィールの値。プロフィールオブジェクト内の特定のフィールドに null が割り当てられると、そのフィールドの値のみが消去されます。ユーザーチャットプロフィールの値は、ユーザーチャットが作成される際に適用されます。