Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Voice React Native SDK Changelog



1.0.0 (Mar 25, 2024)

100-mar-25-2024 page anchor

Twilio Voice React Native SDK has now reached milestone 1.0.0 and is Generally Available (GA). Included in this version are the following.

Features

features page anchor

Call Message Events (Beta)

call-message-events-beta page anchor
  • Allow sending and receiving "user-defined" messages during an ongoing Voice Call and during a pending Call Invite.
  • To send a CallMessage, and handle sent and failure cases:

_14
const message = new CallMessage({
_14
content: { key1: 'This is a message from the parent call' },
_14
contentType: CallMessage.ContentType.ApplicationJson,
_14
messageType: CallMessage.MessageType.UserDefinedMessage
_14
});
_14
const outgoingCallMessage: OutgoingCallMessage = await call.sendMessage(message);
_14
_14
outgoingCallMessage.addListener(OutgoingCallMessage.Event.Failure, (error) => {
_14
// outgoingCallMessage failed, handle error
_14
});
_14
_14
outgoingCallMessage.addListener(OutgoingCallMessage.Event.Sent, () => {
_14
// outgoingCallMessage sent
_14
});

  • To receive a CallMessage:

_10
call.addListener(Call.Event.MessageReceived, (message: CallMessage) => {
_10
// callMessage received
_10
});

  • See related Voice SDK Call Message Events docs here .
  • Fixed and improved the docstrings for the Voice and Call listeners. The descriptions of the events and listeners should now point to the correct docstrings.
  • Call quality warning events should now properly pass arguments to listener functions.
  • The API for call.getInitialConnectedTimestamp() has now changed. Please see the API documentation here(link takes you to an external page) for details. The method call.getInitialConnectedTimestamp() now returns a Date object.


    _10
    const call = voice.connect(...);
    _10
    const date = call.getInitialConnectedTimestamp();
    _10
    const millisecondsSinceEpoch = date.getTime();

  • The API for Call Invite events has now changed.

    The following events have been moved from the Voice class to the CallInvite class:

    • Voice#callInviteAccepted is now CallInvite#accepted
    • Voice#callInviteRejected is now CallInvite#rejected
    • Voice#callInviteNotificationTapped is now CallInvite#notificationTapped
    • Voice#cancelledCallInvite is now CallInvite#cancelled

    Please see the Voice class API documentation here(link takes you to an external page) for details.

    Please see the CallInvite class API documentation here(link takes you to an external page) for details.

  • Call Notifications can be customized on Android.

    The following features regarding a call notification can now be modified:

    • Incoming/outgoing/answered call notification tray icon
    • Name of caller or recipient

    The incoming/outgoing/answered call notification tray icon can be changed by adding a drawable resource with the following id to your application:

    • incoming_call_small_icon for incoming call notifications
    • answered_call_small_icon for answered call notifications
    • outgoing_call_small_icon for outgoing call notifications

    The name of the caller or recipient of a call in the notification can be set by adding the following string resources with the following ids to your application:

    • incoming_call_caller_name_text for incoming call notifications
    • outgoing_call_caller_name_text for outgoing call notifications
    • answered_call_caller_name_text for answered call notifications
      • NOTE: For incoming_call_caller_name_text and answered_call_caller_name_text , the substring ${from} will be replaced with the caller and for outgoing_call_caller_name_text , the substring ${to} will be replaced with the recipient of the call (if available, defaulting to "unknown").
  • Custom functionality around the displayName TwiML parameter has been removed.

    In previous versions of the SDK, passing a custom TwiML parameter displayName would override the notification on Android platforms. Now, this functionality has been removed and notification customization is handled with the above features.

Platform Specific Changes

platform-specific-changes page anchor
Android
android page anchor
  • Call timestamp now in simplified ISO-8601 format, not stored as a double from epoch.
  • Uses system provided notification styles for incoming and outgoing calls. This ensures visual consistency between devices.
  • Fixed issue where call records were not being removed after call was ended.
  • The call connected timestamp is now in simplified ISO-8601 format.
  • A new method CallInvite.updateCallerHandle() has been added. Use this method to update the caller's name displayed in the iOS system incoming call UI. This method is specific to iOS and unavailable in Android.

1.0.0-beta.4 (Jan 11, 2024)

100-beta4-jan-11-2024 page anchor

Twilio Voice React Native SDK has now reached milestone beta.4. Included in this version are the following.

Platform Specific Features

platform-specific-features page anchor
  • Fixed an issue with exported types. Typescript language server hinting should now properly prioritize the narrower, more helpful, event-emitter types.
  • Narrowed the CustomParameters type to Record<string, string> instead of Record<string, any> .
  • Fixed inconsistency with AudioDevice typings, preferring undefined over null for optional values.
  • Fixed an issue with call.isMuted() and call.isOnHold() APIs. They should now always return boolean \| undefined instead of potentially returning null .
  • Fixed an issue with call.getFrom() , call.getTo() , and call.getSid() APIs. They should now always return string \| undefined instead of potentially returning null .
  • Fixed a bug where the call invite results in a rejected event when the call is hung up by the caller.
  • Fixed a bug where the registered and unregistered events are not fired on iOS.
  • Fixed an issue where timestamps emitted by the iOS layer were in the wrong units (seconds instead of milliseconds).
  • Replace frontline notification images with generic phone images
  • In call notifications now display when accepting a call from JS application
  • Audio routing for incoming and outgoing calls are now correctly routed
  • Internal simplification of call accepted/rejected intent message paths
  • Refactored internals & added permissions for Bluetooth and notifications. Please Note that these changes require changes to the application integrating the SDK. For more information, please refer to the Beta.4 migration guide(link takes you to an external page).

1.0.0-beta.3 (August 26, 2023)

100-beta3-august-26-2023 page anchor

Twilio Voice React Native SDK has now reached milestone beta.3. Included in this version are the following.

  • Added documentation about outgoing call ringback tones.
  • Added more call info persistance. The native layers will now persist call state and initial connected timestamps.
  • Applications can now choose to use their own iOS PushKit implementation or delegate the incoming call handling to the SDK's default handler by calling the Voice.initializePushRegistry() method, referred henceforth as the "SDK PushKit handler".

    Note that when not using the "SDK PushKit handler", applications will need to notify the SDK upon receiving PushKit device token updates so the SDK can perform registration properly. Applications will also need to notify the SDK upon receiving push notifications so the SDK can report incoming calls to the iOS CallKit framework properly. See this page(link takes you to an external page) for more details.

  • Incoming call notifications can now be tapped to bring the application into the foreground.
  • Tapping on an incoming call notification will emit an event. See Voice.Event.CallInviteNotificationTapped for more information.
  • Use latest versions of Twilio Voice Android SDK and the Audioswitch libraries.
  • Fixed a bug where switching from Bluetooth to the iOS earpiece during a call does not have any effect or error.
  • Fixed an issue where audio device types were incorrectly labeled using capitalized descriptions. I.e. Earpiece instead of earpiece .
  • Fixed return value of Call.mute and Call.hold to return the new mute/hold value. Thanks to our community (@treycucco with PR #164) for this addition!
  • IncomingCallService now specifies foreground service type MICROPHONE on API >= 30 devices. This fixes issues with microphone access for backgrounded apps. Note that this change also resulted in the compiled SDK verison being bumped to 33 from 29 .

1.0.0-beta.2 (June 23, 2023)

100-beta2-june-23-2023 page anchor

Twilio Voice React Native SDK has now reached milestone beta.2. Included in this version are the following.

  • Pinned to a specific version of the Twilio Voice iOS SDK. This fixes issues with some builds failing on iOS platforms.
  • Fixed the Intent flags on Android platforms. This fixes issues with the application crashing on newer versions of Android.
  • Calls will now persist their state through JS runtimes. Now, if the React Native JS layer encounters a restart, and if your code performs Voice.getCalls , the Call objects will now have the proper state.
  • Calls will now persist a timestamp (millseconds since epoch) of when they initially receive the Call.Event.Connected event. See Call.getInitialConnectedTimestamp .

1.0.0-beta.1 (March 10, 2023)

100-beta1-march-10-2023 page anchor

Twilio Voice React Native SDK is now in beta! Please see the following changes with this new release. Additionally, we are also introducing the new Twilio Voice React Native Reference App as an example implementation of the Twilio Voice React Native SDK and serves to inspire developers who want to leverage the power of Twilio Programmable Voice in their React Native applications. Please see this page(link takes you to an external page) for more details.

  • The integration testing app formerly under example/ has been renamed/moved to test/app/ .
  • The React Native dependency within the integration testing app has been updated from 0.63.4 to 0.66.5 .

The voice.connect method now has the following function signature


_10
voice.connect(token: string, options?: Voice.ConnectOptions);
_10
_10
interface Voice.ConnectOptions {
_10
contactHandle?: string;
_10
params?: Record<string, string>;
_10
}

Not passing an options object or leaving any member of the options object undefined will result in those options using default values. See the API documentation for descriptions of options here(link takes you to an external page).

The SDK now exports error classes and emits error objects specific to an error code. See the below code snippet for usage.


_13
import { TwilioErrors } from '@twilio/voice-react-native-sdk';
_13
// ...
_13
voice.on(Voice.Event.Error, (error: TwilioErrors.TwilioError) => {
_13
if (error instanceof TwilioErrors.AuthorizationErrors.AccessTokenInvalid) {
_13
// Update your UI to reflect an invalid access token.
_13
}
_13
_13
// Alternatively, your application logic can use the error code.
_13
_13
if (error.code === 20101) {
_13
// Update your UI to reflect an invalid access token.
_13
}
_13
});

See the API Docs(link takes you to an external page) for all error classes.

  • Fixed an issue where some types on the Call and Voice classes were being incorrectly exported. Types and references to addEventListener are instead now correctly exported as addListener .
  • Fixed an issue where available audio devices were sometimes incorrectly emitted and returned by the SDK on Android platforms. This occurs more frequently in development environments when the JS bundle is reloaded, but could happen in production environments as well.
  • Fixed a warning that occurred on more recent versions of React Native when the SDK constructed a NativeEventEmitter .
  • Fixed an issue where devices running Android 12+ encountered crashes when receiving an incoming call or making an outgoing call.

1.0.0-preview.1 (September 1, 2022)

100-preview1-september-1-2022 page anchor

Rate this page: