Web URL パラメータ
概要
IMKIT が提供する Web URL は、query parameter を介して初期化動作を制御できます。ログイン token、デフォルトのチャットルーム、ダークモードなどに対応しています。本ページでは、サポートされているすべてのパラメータ、URL 上の配置位置、そして一般的な使用シナリオを紹介します。
パラメータ一覧
| パラメータ | 必須 | 型 | デフォルト値 | 説明 |
|---|---|---|---|---|
token | ✅(初回埋め込み時) | string | localStorage 内の既存 token | JWT 認証 token。読み込み後は自動的に localStorage に保存され、URL バーから削除されます |
autoSelectRoom | ❌ | "0" | (有効) | 読み込み時に最初のチャットルームを自動選択するかどうか。0 を設定すると無効化 |
roomId | ❌ | string | (なし) | 入室するチャットルームの ID を指定。設定すると RoomList は非表示になり、単一チャットルームの埋め込みに適しています |
roomTag | ❌ | string | (なし) | チャットルームの tag フィルタ。指定した tag を持つチャットルームのみを表示 |
darkMode | ❌ | "true" / "1" / "false" / "0" | システム設定に従う | ダークモード / ライトモードの切り替え |
URL フォーマット
IMKIT フロントエンドは hash routing を使用しているため、パラメータの配置位置によって読み取り方式が異なります。下表に従って正しい位置に配置してください。
フォーマット A:hash(#)の前
適用パラメータ:token(初回読み込み)、autoSelectRoom、roomId、roomTag
https://your-app.imkit.io/?token=ユーザーの_TOKEN&roomId=ROOM_ID&autoSelectRoom=0#/フォーマット B:hash ルートの後
適用パラメータ:token(動的切り替え)、darkMode
https://your-app.imkit.io/#/?darkMode=1&token=ユーザーの_TOKEN
tokenは両方の位置をサポートします:初回読み込みではフォーマット A に配置してください(読み込み後は localStorage に自動保存され、URL から削除されます。スクリーンショットや共有による漏洩を防止);実行中の token 動的切り替えではフォーマット B に配置してください(socket の再接続と既存 store のクリアがトリガーされます)。
使用シナリオ
1. 特定のチャットルームを埋め込む(ルーム一覧を非表示)
https://your-app.imkit.io/?token=ユーザーの_TOKEN&roomId=6073a1b2c3d4e5f6a7b8c9d0#/サードパーティのシステムで特定のチャットルームのみを表示したい場合に適しています。例えば、カスタマーサポートシステムで単一の対話画面を埋め込む場合など。
2. ダークモードを強制
https://your-app.imkit.io/#/?darkMode=1ダークテーマの app やページに埋め込む場合に適しており、テーマの不一致を防ぎます。
3. 自動選択を無効化 + 完全なルーム一覧を表示
https://your-app.imkit.io/?token=ユーザーの_TOKEN&autoSelectRoom=0#/モバイル web でユーザー自身に入室するチャットルームを選んでほしい場合に適しています。
4. tag によるチャットルームのフィルタリング
https://your-app.imkit.io/?token=ユーザーの_TOKEN&roomTag=customer-support#/customer-support tag を持つチャットルームのみを表示します。一つの IMKIT app で複数シナリオを共用する際の振り分けに便利です。
注意事項
tokenのセキュリティ:フォーマット A のtokenは、SDK が読み込んだ後、ブラウザの URL バーから自動的に削除されlocalStorageに保存されます。スクリーンショットや共有による漏洩リスクを低減します。darkModeの値:現在"true"/"1"/"false"/"0"のみ受け付けます。"dark"や"light"と書いても動作しません。roomIdと RoomList:roomIdを指定すると RoomList は非表示になり、単一チャットルームの埋め込みに適しています。ルーム一覧を残したまま特定のチャットルームを事前選択したい場合は、埋め込み後に SDK API で切り替えてください。autoSelectRoomのデフォルト:このパラメータを指定しない場合、デフォルトで有効(読み込み後に最初のチャットルームを自動選択)です。"0"のみ無効化されます。