@twilio/voice-react-native-sdk
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Twilio Voice React Native SDK

NPM CircleCI

Twilio's Voice React Native SDK allows you to add real-time voice and PSTN calling to your React Native apps.

Please check out the following if you are new to Twilio's Programmable Voice or React Native.

Issues and Support

Please check out our common issues page or file any issues you find here on Github. For general inquiries related to the Voice SDK you can file a support ticket. Please ensure that you are not sharing any Personally Identifiable Information(PII) or sensitive account information (API keys, credentials, etc.) when reporting an issue.

Access Tokens

An Access Token is required to make outgoing calls or receive incoming calls. Please check out this page for more details on creating Access Tokens.

Installation

The package is available through npm.

yarn add @twilio/voice-react-native-sdk

Usage

The following example demonstrates how to make and receive calls. You will need to implement your own getAccessToken() method for it to work properly. Please see Access Tokens section for more details or check out the iOS and Android quickstart for examples on how to generate the tokens. For more information on the Voice React Native SDK API, refer to the API Docs or see our Reference App.

import { Voice } from '@twilio/voice-react-native-sdk';

const token = getAccessToken();
const voice = new Voice();

// Allow incoming calls
await voice.register(token);

// Handle incoming calls
voice.on('callInvite', (callInvite) => {
  callInvite.accept();
});

// Make an outgoing call
const call = await voice.connect(token, params);

Ringtone

To use a custom ringtone for outgoing calls, please see the documentation located at docs/play-outgoing-call-ringback-tone.md.

Related

Examples

License

See LICENSE

Package Sidebar

Install

npm i @twilio/voice-react-native-sdk

Weekly Downloads

446

Version

1.0.0

License

MIT

Unpacked Size

2.6 MB

Total Files

206

Last publish

Collaborators

  • twilio-vblocks-ci