Skip to main content

Web SDK とは

Web SDK はウェブサイトに埋め込む小さなコードです。訪問者が「今すぐ話す」ボタンをクリックすると、ブラウザ内でマイクを使って OneInbox エージェントとのライブ音声会話が始まります。 ライブチャットウィジェットの音声版と考えてください。 SDK が処理するもの:
  • ブラウザへのマイク許可のリクエスト
  • リアルタイムの音声ストリーミング(双方向)
  • 会話中のライブトランスクリプト表示
  • ミュート、ミュート解除、ハングアップ
チームがセットアップするもの:
  • OneInbox のエージェント(応答する AI)
  • 通話を開始するサイト上のボタンまたはウィジェット

クイックスタート — サイトへの最も簡単な追加方法

これが最速のパスです:公開可能なキー + Web SDK、バックエンド不要。
1

エージェントを作成する

通話に応答するエージェントを構築します — まだ作成していない場合は クイックスタート を参照してください。その idagt_…)を保存します。
2

公開可能なキーを作成する

OneInbox ダッシュボードSettings → Publishable KeysCreate key へ。このキーに許可するオリジンを入力します — 1 行に 1 つ:キーをコピーします — oi_pk_live_… で始まります。
* を使用すると、どのウェブサイトでもあなたの公開可能なキーを使ってエージェントへの通話を開始できます。ローカルテストには問題ありませんが、本番稼働前に実際のドメインに制限してください。
3

Web SDK をインストールする

4

エージェントに接続する

公開可能なキーで SDK を初期化し、start() でエージェントの id を指定します:
5

サイトにボタンを追加する

start() の呼び出しを任意のボタンに接続します — 例えば「今すぐ話す」。訪問者がクリックすると、マイクを使ってブラウザ内でその場で通話が始まります。
以上です — サーバー不要、別途「通話を作成する」ステップも不要です。完全なイベント/コントロール API(ミュート、トランスクリプト、ハングアップなど)は以下の Vanilla サンプルReact サンプル にあります。

プロダクトへの組み込み方

訪問者が「通話する」をクリックすると:
  1. ウェブサイトがサーバーに問い合わせます:「この訪問者の通話を開始して」
  2. サーバーが OneInbox API 経由で通話を作成し、短命のアクセストークンを受け取ります
  3. Web SDK がそのトークンを使って訪問者のブラウザをエージェントに接続します
  4. 会話が始まります — ライブ、双方向の音声
サーバーが秘密の API キーを保持します。ブラウザは通話終了時に期限切れになる一時トークンのみを受け取ります — 訪問者に機密情報が漏洩しません。

2 つのパッケージ

どちらも同じことをします。React パッケージは React に使いやすいパターンでコアをラップしたものです。

インストール

各パッケージは自己完結型です — SDK は音声接続を処理するのに必要なすべてをバンドルしているため、他のコンパニオンパッケージのインストールは不要です。

Vanilla サンプル

リッスンできるイベント

コントロール


React サンプル

useOneInbox() は通話 UI の構築に必要なすべてを提供します: