ガイド
Capacitor で Twilio Voice を使う方法
@capgo/capacitor-twilio-voice の使用方法
Twilio Voice SDK を Capacitor に統合します
インストール
bun add @capgo/capacitor-twilio-voice
bunx cap sync
bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。
インポート
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
API の概要
| メソッド | 説明 |
|---|---|
login |
アクセストークンを使用して、Twilio Voiceでユーザーを認証します。 |
logout |
現在のユーザーをログアウトし、Twilio Voiceの登録を解除します。 |
isLoggedIn |
ユーザーが現在ログインしており、有効なアクセストークンを持っているか確認します。 |
makeCall |
電話番号またはクライアントへの発信を開始します。 |
acceptCall |
着信に応答します。 |
rejectCall |
着信を拒否します。 |
endCall |
通話を終了します。 |
muteCall |
通話中にマイクのミュート/解除を切り替えます。 |
setSpeaker |
スピーカーモードの有効/無効を切り替えます。 |
getCallStatus |
現在の通話ステータスを取得します。 |
checkMicrophonePermission |
マイクの権限が許可されているか確認します。 |
requestMicrophonePermission |
ユーザーにマイクの権限をリクエストします。 |
例
login()
アクセストークンを使用して Twilio Voice でユーザーを認証します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const result = await CapacitorTwilioVoice.login({
accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
});
console.log('Login successful:', result.success);
logout()
現在のユーザーをログアウトし、Twilio Voice の登録を解除します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const result = await CapacitorTwilioVoice.logout();
console.log('Logout successful:', result.success);
isLoggedIn()
ユーザーがログイン済みで、有効なアクセストークンを持っているか確認します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
const status = await CapacitorTwilioVoice.isLoggedIn();
if (status.isLoggedIn && status.hasValidToken) {
console.log('User identity:', status.identity);
} else {
// Re-authenticate the user
}
makeCall()
電話番号またはクライアントへの発信を開始します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
// Call a phone number
const result = await CapacitorTwilioVoice.makeCall({
to: '+1234567890'
});
console.log('Call SID:', result.callSid);
// Call another Twilio client with a readable name for CallKit Recents
await CapacitorTwilioVoice.makeCall({
to: 'client:alice',
displayName: 'Alice Smith'
});
// Call a PSTN number using a specific caller ID
await CapacitorTwilioVoice.makeCall({
to: '+1234567890',
callerId: '+10987654321'
});
acceptCall()
着信に応答します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
console.log('Incoming call from:', data.from);
const result = await CapacitorTwilioVoice.acceptCall({
callSid: data.callSid
});
console.log('Call accepted:', result.success);
});
rejectCall()
着信を拒否します。
import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';
CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
if (shouldRejectCall(data.from)) {
await CapacitorTwilioVoice.rejectCall({
callSid: data.callSid
});
}
});
上記の表は12個のコアメソッドを一覧にしています。リスナーとバージョンのヘルパー、および各メソッドの完全な仕様は、以下に記載されています。 GitHub リポジトリ.
イベントをリッスンする
addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() 画面がアンマウントされるとき、または CapacitorTwilioVoice.removeAllListeners() すべてのリスナーを解除します。
完全なリファレンス
Using @capgo/capacitor-twilio-voice から続ける
使用している場合 @capgo/capacitor-twilio-voice の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください： @capgo/capacitor-twilio-voice @capgo/capacitor-twilio-voice の実装詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。