Mulai

Instal

Kamu bisa menggunakan Pengaturan Asisten AI kami untuk menginstal plugin ini. Tambahkan kemampuan Capgo ke alat AI kamu menggunakan perintah berikut:

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

Kemudian gunakan prompt berikut:

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

Jika kamu lebih suka Menggunakan Tangan, instal plugin ini dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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

Import

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

API Pengantar

login

Autentikasi pengguna dengan Twilio Voice menggunakan token akses.

Token akses harus dihasilkan di server backend Anda menggunakan kredit Twilio Anda. Token ini diperlukan untuk membuat dan menerima panggilan melalui Twilio Voice.

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

const result = await CapacitorTwilioVoice.login({
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
});
console.log('Login successful:', result.success);

logout

Keluar dari pengguna saat ini dan melepaskan registrasi dari Twilio Voice.

Langkah ini akan memutuskan panggilan aktif dan menghentikan perangkat dari menerima notifikasi panggilan masuk baru.

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

const result = await CapacitorTwilioVoice.logout();
console.log('Logout successful:', result.success);

isLoggedIn

Periksa apakah pengguna saat ini sudah masuk dan memiliki token akses yang valid.

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

Mulai panggilan keluar ke nomor telepon atau klien.

Pengguna harus masuk terlebih dahulu sebelum melakukan panggilan. Panggilan akan diarahkan melalui konfigurasi backend Twilio Anda.

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

Terima panggilan masuk.

Proses ini harus dipanggil dalam respons terhadap event ‘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

Tolak panggilan masuk.

Perlu dipanggil dalam respons terhadap sebuah ‘callInviteReceived’ event. Pengirim akan mendengar sinyal penuh atau dialihkan ke kotak suara.

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

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

endCall

Selesai panggilan aktif.

Jika callSid tidak disediakan, ini akan menutup panggilan aktif saat ini.

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

Matiin atau aktifkan mikrofon selama panggilan aktif.

Ketika mati, pihak lain tidak akan mendengar suara dari mikrofon Anda.

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

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

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

setSpeaker

Aktifkan atau nonaktifkan mode speakerphone.

When diaktifkan, audio akan dialirkan melalui speaker perangkat daripada earpiece.

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

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

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

getCallStatus

Peroleh status panggilan aktif saat ini.

Informasi waktu nyata tentang status panggilan, status bisu, status menahan, dan identifikasi panggilan.

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

Periksa apakah izin mikrofon telah diberikan.

Perlu diingat bahwa ini tidak meminta izin, melainkan hanya memeriksa status izin saat ini.

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

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

requestMicrophonePermission

Meminta izin mikrofon dari pengguna.

Di iOS dan Android, hal ini akan menampilkan dialog izin sistem jika izin belum diberikan. Jika izin sebelumnya ditolak, pengguna mungkin perlu mengizinkannya di pengaturan sistem.

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');
}

Referensi Tipe

CallInvite

Capacitor plugin untuk mengintegrasikan fungsi suara Twilio ke dalam aplikasi mobile.

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>;
}

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Re-run sinkronisasi ketika API publik berubah secara upstream.

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan operasi API, hubungkannya dengan Menggunakan @capgo/capacitor-twilio-voice untuk kemampuan asli di Menggunakan @capgo/capacitor-twilio-voice, API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, Kunci API untuk detail implementasi di Kunci API, dan Perangkat untuk detail implementasi di Perangkat.