Getting Started

インストール

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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.

クリップボードにコピー

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

クリップボードにコピー

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が指定されていない場合、この機能は現在の通話を終了します。

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.tsAPI の公開変更が上流で発生した場合に再度同期を実行してください。

はじめから始める

「はじめから始める」 Getting Started DashboardとAPIの運用を計画し、接続する @capgo/capacitor-twilio-voiceを使用する @capgo/capacitor-twilio-voiceのネイティブ機能について APIの概要 APIの実装詳細について 導入 導入の実装詳細について APIのキー APIのキーに関する実装詳細について デバイス デバイスの実装詳細について