시작하기

설치

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 개요

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

로그인 한 사용자인지 확인하고 유효한 access 토큰이 있는지 확인합니다.

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

현재 진행 중인 통화를 종료합니다.

클립보드 복사

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

__CAPGO_KEEP_0__

켜져 있을 때, 음성은 장치의 스피커를 통해 전달되며耳폰 대신에.

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.tspublic API이 업스트림에서 변경될 때 다시 싱크를 실행하세요.

Getting Started에서 계속하세요

만약에 Getting Started 계획 대시보드와 API 연산을 위해 Using @capgo/capacitor-twilio-voice Using @capgo/capacitor-twilio-voice API Overview API Overview Introduction Introduction API Keys API Keys 기기 기기 구현에 대한 세부 정보입니다.