Web SDK とは
Web SDK(@oneinbox/web-sdk)は OneInbox の フロントエンドブラウザ音声ライブラリです。アクティブな Web 通話 セッションにユーザーのブラウザを接続します。
Web 通話は 作成しません。先にバックエンドで POST /v1/calls/web で Web 通話を作成 — Web 通話 ガイドを参照。
必要な値
| 値 | 取得元 |
|---|---|
server_url | Web 通話 レスポンス(例: wss://voice.oneinbox.ai) |
participant_token | 同上 — このセッション用の短期トークン |
アーキテクチャ
Web SDK が担うもの
server_urlとparticipant_tokenでの接続- ブラウザのマイクアクセスと音声ストリーミング
- 通話状態(接続中、アクティブ、終了)
- UI からの切断 / 通話終了
- エージェントや LLM モデルの作成
POST /v1/calls/webの呼び出し(バックエンドの役割)- API キーの保存または使用
1. バックエンド — Web 通話トークンの中継
サーバーが Web 通話 を作成し、フロントに必要な値のみ返します:
他パスとの比較
トラブルシューティング
| 問題 | 対処 |
|---|---|
OneInbox から 401 | Web 通話作成時のバックエンド API キーを確認 |
| Web SDK が接続できない | バックエンドから新しい server_url と participant_token を取得 |
| 音声が出ない | ブラウザのマイク許可;本番は HTTPS |
| フロントに API キー | Web 通話はバックエンドでのみ作成 |