@hello-x/web

HelloX 電話機能 SDK のブラウザ向け実装。WebRTC + WebSocket で Asterisk と通信し、SIP 通話 (発信・着信・通話制御) を JS API として提供します。

インストール

npm install @hello-x/web

ブラウザネイティブの WebRTC API (RTCPeerConnection / MediaStream / navigator.mediaDevices) を利用するため、追加の peerDependency はありません。

動作環境

• HTTPS 環境または localhost (WebRTC は secure context を要求)
• 主要モダンブラウザ (Chrome / Firefox / Safari / Edge)
• SSR 環境はサポート外 (localStorage および navigator を直接利用)

着信音

着信時に着信音を鳴らします (既定で有効)。音源ファイルは持たず、Web Audio API で着信音を合成します。

ブラウザの autoplay ポリシー対策として、SDK は最初のユーザー操作 (クリック / キー入力) を一度だけ捕まえて AudioContext を resume します。利用側での追加対応は不要です。

着信音を無効化する場合は ringtone: false を渡します。

const sdk = new HelloX({ tokens: { accessToken: "...", refreshToken: "..." }, ringtone: false });

ドキュメント

利用方法・API リファレンス・エラーハンドリング・トラブルシューティングは ドキュメントサイト に集約しています。