ガイド
ウェブウィジェット
埋め込み可能な JS ウィジェットをカスタマイズ 、 ブランディング、ユーザー識別、イベント。
Web ウィジェットは小さな JS バンドル(gzip 後で約 30 kB)で、任意のページの 右下隅にチャットバブルをマウントします。
読み込み
<script src="https://singchat.org/widget.js"
data-app-id="YOUR_APP_ID"
data-base-url="https://singchat.org"></script>ログイン済みユーザーの識別
匿名の訪問者に対しては、ウィジェットが自動的にコンタクトを生成します。ログイン済みユーザーに対しては、SingChat.identify() をユーザー情報とともに呼び出してください:
window.SingChat.identify({
externalId: "user_123",
name: "Ada Lovelace",
email: "ada@example.com",
customAttributes: { plan: "pro", signupAt: "2025-01-12" },
});プログラムによる開閉
SingChat.open();
SingChat.close();
SingChat.toggle();イベントのリッスン
SingChat.on("message:new", (msg) => {
console.log("new message", msg);
});
SingChat.on("ai:stream:end", ({ messageId }) => {
// AI finished streaming
});テーマ設定
Settings → Inboxesでは、ウィジェットのプライマリ カラー、位置、挨拶文を設定できます。ホワイトラベル("Powered by AskAIs" を非表示) は Pro 以上で利用できます。
セキュリティ
app-idは公開情報です 、 HTML に含めても問題ありません- シークレットキーはサーバーサイド専用です 、 ブラウザのコードに決して公開しないでください
- 高い信頼性が求められるユースケースでは、サーバーサイドでシークレットキーを使ってユーザーペイロードに署名してください (HMAC-SHA256)、 API 認証 を参照してください