Twilio Voice __CAPGO_KEEP_0__ リポジトリ

インストール

CapgoのAIアシストセットアップを使用してプラグインをインストールできます。AIツールにCapgoスキルを追加するには、以下のコマンドを使用してください:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-twilio-voice` plugin in my project.

Manual Setupを選択する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム固有の手順に従ってください。

bun add @capgo/capacitor-twilio-voice
bunx cap sync

インポート

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

API オーバービュー

login

Twilio Voiceを使用してユーザーを認証するには、アクセストークンが必要です。

アクセストークンは、Twilioのクレデンシャルを使用してバックエンドサーバーで生成する必要があります。 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

電話番号またはクライアントにオフラインの通話を開始します。

ユーザはログインしている必要があります。通話は、Twilio のバックエンド設定に基づいてルーティングされます。

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

incoming callを受け入れる

‘callInviteReceived’ イベントの応答として呼び出されるべきです。

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

incoming callを拒否する

‘callInviteReceived’ イベントの応答として呼び出されるべきです。 コールャーは忙しい信号を聞くか、メッセージボックスに誘導される

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

CapacitorTwilioVoice.addListener('callInviteReceived', async (data) => {
  if (shouldRejectCall(data.from)) {
    await CapacitorTwilioVoice.rejectCall({
      callSid: data.callSid
    });
  }
});

endCall

現在のアクティブなコールを終了する

コールSIDが提供されていない場合、この呼び出しは現在のアクティブなコールを終了します。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// End the current active call
await CapacitorTwilioVoice.endCall({});

// End a specific call
await CapacitorTwilioVoice.endCall({
  callSid: 'CA1234567890abcdef'
});

muteCall

通話中のマイクをミュートまたはアンミュートします。

ミュートされている場合、他のパーティーはマイクから音を聞くことができません。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// Mute the microphone
await CapacitorTwilioVoice.muteCall({
  muted: true
});

// Unmute the microphone
await CapacitorTwilioVoice.muteCall({
  muted: false
});

setSpeaker

スピーカーモードを有効または無効にします。

有効になると、音は耳からではなくデバイスのスピーカーから流れます。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

// Enable speakerphone
await CapacitorTwilioVoice.setSpeaker({
  enabled: true
});

// Disable speakerphone
await CapacitorTwilioVoice.setSpeaker({
  enabled: false
});

getCallStatus

現在の通話の状態を取得します。

これは、通話の状態、ミュート状態、ホールド状態、通話識別子についてリアルタイムで情報を提供します。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const status = await CapacitorTwilioVoice.getCallStatus();
if (status.hasActiveCall) {
  console.log('Call SID:', status.callSid);
  console.log('Call State:', status.callState);
  console.log('Is Muted:', status.isMuted);
  console.log('Is On Hold:', status.isOnHold);
}

checkMicrophonePermission

マイクの許可が付与されているかどうかを確認します。

許可を求めることはありません。現在の許可状態のみを確認します。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.checkMicrophonePermission();
if (!result.granted) {
  console.log('Microphone permission not granted');
}

requestMicrophonePermission

ユーザーからマイクの許可を要求します。

iOS と Android の場合、許可がまだ付与されていない場合はシステムの許可ダイアログが表示されます。許可が以前拒否された場合は、ユーザーはシステムの設定で許可を付与する必要があります。

import { CapacitorTwilioVoice } from '@capgo/capacitor-twilio-voice';

const result = await CapacitorTwilioVoice.requestMicrophonePermission();
if (result.granted) {
  console.log('Microphone permission granted');
} else {
  console.log('Microphone permission denied');
}

型の参照

CallInvite

Capacitor plugin for integrating Twilio Voice functionality into mobile applications.

export interface CallInvite {
  /** Unique identifier for the incoming call invitation */
  callSid: string;
  /** Phone number or client identifier of the caller (may include custom caller name) */
  from: string;
  /** Phone number or client identifier being called */
  to: string;
  /** Custom parameters passed with the call invitation */
  customParams: Record<string, string>;
}

真実の源

このページはプラグインの src/definitions.tspublic APIがアップストリームで変更された場合に再度同期を実行してください。

Getting Startedから続けてください

あなたが Getting Started ダッシュボードとAPIの作業を計画する場合に接続してください。 Using @capgo/capacitor-twilio-voice Using @capgo/capacitor-twilio-voice API オーバービュー API オーバービューの実装詳細について イントロダクション イントロダクションの実装詳細について API キー API キーの実装詳細について、 デバイス デバイスの実装詳細について。