开始入门

安装

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。

此操作将断开任何正在进行的通话并停止设备接收新 incoming 来电通知。

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

结束 active call.

如果 callSid 未提供，则将结束当前 active call。

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

如果您正在使用 Getting Started 来规划仪表板和 API 操作，请将其连接到 使用 @capgo/capacitor-twilio-voice 为 Using @capgo/capacitor-twilio-voice 中的原生功能 API概述 为API概述提供的实现细节 介绍 为介绍提供的实现细节 API密钥 为API密钥提供的实现细节,以及 设备 为设备提供的实现细节