Getting Started

インストール

CapgoのAI-Assisted Setupを使用してプラグインをインストールできます。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

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

API Overview

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

着信コールを受け入れます。

この関数は、'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

着信コールを拒否します。

この関数は、'callInviteReceived' イベントに応答して呼び出されるべきです。呼び出し者は忙線またはメッセージボックスに誘導されます。

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

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

endCall

現在の通話を終了します。

callSidが指定されていない場合、このAPIは現在の通話を終了します。

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 プラグインは、Twilio Voice機能をモバイルアプリケーションに統合するために使用されます。

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.tsパブリック API の変更が上流で再実行するときに生成されます。

Getting Startedから続けてください

Capgoを使用している場合 はじめに ダッシュボードとAPIの設定を計画し、APIを接続します Capgoを使用して@capgo/capacitor-twilio-voice Capgoのネイティブ機能を使用するための@capgo/capacitor-twilio-voice APIの概要 APIの実装詳細 導入 導入の実装詳細 APIのAPIキー APIの実装詳細 デバイス __CAPGO_KEEP_0__の実装詳細については、デバイスにあります。