ドキュメント

JavaScript API

ウィジェットスクリプトを読み込んだ後に利用できるグローバルメソッドです。

Respondo.init(config)

ウィジェットを初期化してマウントします。1 回だけ呼び出す必要があります。ウィジェットインスタンスを返します。

const widget = Respondo.init({
  agentId: 'YOUR_AGENT_ID'
});

Respondo.identify(identity)

ユーザー ID を現在のセッションに添付します。ログイン後に呼び出してください。メールアドレスまたは userId があれば、ユーザーがチャットを一度も開かなくてもすぐに連絡先を作成します。signedUpAt(Date、Unix 秒、または ISO 8601 文字列)は、ユーザーが貴社の製品に登録した日時です。指定しない場合、連絡先の登録日は空のままです。

Respondo.identify({
  email: 'user@example.com',
  name: 'John Doe',
  userId: 'usr_123',
  signedUpAt: '2024-05-31T10:00:00Z',
  userHash: 'hmac_sha256_signature', // 任意、本人確認用
  metadata: { plan: 'pro' },
  properties: {                      // カスタムの連絡先プロパティ
    account_type: 'enterprise',      // キーは Agent Settings で定義
    region: 'eu-west'
  }
});

Respondo.track(name, properties?)

現在の訪問者のクライアントサイドイベント(購入、プランのアップグレードなど)を記録します。イベントはイベントトリガー型のツアーを開始でき、ツアーのゴールにもカウントされます。 keepalive によるベストエフォート配信のため、ナビゲーション直前(チェックアウトへのリダイレクトなど)に発火したイベントも届きます。 init() の後に呼び出してください。

イベントは、そのイベントを待っているポップアップアンケート(When and where)も開きます。条件に合うページにいればすぐに、30 分以内にそうしたページへ移動すれば到着時に(リダイレクト後など)開きます。

Respondo.track('purchase_completed', {
  plan: 'pro',
  amount: 49
});

Respondo.startSurvey(surveyId)

公開中のポップアップアンケートを、どのページでも今すぐ開きます。Show on、ページルール、ページの滞在時間、トリガーイベント、オーディエンスは無視されます。ID はアンケートエディター(Additional ways to share)からコピーしてください。訪問者が回答済みのアンケートは再表示されません。ウィジェットの読み込み完了前に呼び出しても構いません。

Respondo.startSurvey('<survey-id>');

Respondo.open(message?) / Respondo.close()

独自のボタンからメッセンジャーを開いたり閉じたりします。open に文字列を渡すと、メッセージ欄に入力済みの状態で開きます。Respondo.init() の後に呼び出してください。ランチャーの表示中に行われた呼び出しは、表示が完了した時点で適用されます。

Respondo.open();
Respondo.open('I have a question about my invoice');
Respondo.close();

Respondo.destroy()

ウィジェットをページから削除します。ウィジェットを表示すべきでないページへ遷移する SPA で便利です。訪問者の ID や保存された会話はクリアされません — ログアウトには Respondo.reset() を使用してください。

// ウィジェットをページから削除
Respondo.destroy();

// 必要なら後で再初期化(同じ会話を再開します)
Respondo.init({ agentId: 'YOUR_AGENT_ID' });

Respondo.reset()

ログアウト / 共有デバイスの引き継ぎ用。匿名の訪問者 ID、保存された会話、セッショントークンをブラウザからクリアし、セッショントークンをサーバー側で失効させて(そのコピーは機能しなくなります)、新しい匿名ウィジェットを再マウントします。アプリのログアウトフックから呼び出してください。

// ログアウト時 — ID、会話、セッションを消去して最初から開始
Respondo.reset();

自動データ収集

ウィジェットは各会話とともに以下を自動的に取得して保存します:

データ取得元
クライアント IPHTTP ヘッダー
ブラウザ / OSUser-Agent ヘッダー
言語Accept-Language ヘッダー
タイムゾーンIntl API(JavaScript)
ページ URLwindow.location
リファラーReferer ヘッダー