Voice Android SDK Changelog

The Twilio Programmable Voice SDKs allow you to add voice-over-IP (VoIP) calling into your native Android applications. See Android Getting Started Guide to begin using the SDK.

Sep 10th 2024

• Programmable Voice Android SDK 6.6.4 [Maven Central] , [docs] MD5 Checksum : 1121d216712bfd06252a35ed4d09c5a7

• The Voice SDK now supports Server Name Indication (SNI) during initial TLS handshake with Twilio infrastructure.

• The CallMessage.Builder.setContentType() API has no effect on the content type of the Call Message object. The content type always defaults to application/json .

Sep 3rd 2024

• Programmable Voice Android SDK 6.6.3 [Maven Central] , [docs] MD5 Checksum : 37633de89f65845cdb3d73f9d63919c2

• Added support for Android 15 with 16k memory page sizes.

• The CallMessage.Builder.setContentType() API has no effect on the content type of the Call Message object. The content type always defaults to application/json .

Aug 26th 2024

• Programmable Voice Android SDK 6.6.2 [Maven Central] , [docs] MD5 Checksum : 87649dd38123fc4310659cd6518c201a

• The Call Message Events (Beta), originally released in 6.3.3, has been promoted to GA. This release includes the following breaking changes from the beta.
  • Changed error code 31209 to 31212 . This error code is emitted when a call message payload exceeds the authorized limit.
  • Call Message types (CallMessage.messageType) are treated as strings instead of enumerated values.
    • The SDK no longer validates CallMessage.messageType and acts as a pass through for unknown message types in both directions (messages received by the SDK and those sent by the SDK).
    • To send a user defined message, the sendMessage() API should be invoked with a CallMessage object where the messageType is set to one of the supported message types from https://www.twilio.com/docs/voice/sdks/call-message-events
    • Added new error code 31210 for invalid call message type when sendMessage() API is invoked with a CallMessage object where the messageType is not set to user-defined-message .
  • Call.CallMessageListener methods have been updated to include the CallSid, which is a unique identifier for the Call or the CallInvite. The updated APIs are:

1
public interface CallMessageListener {
2

3
     void onMessageReceived(final String callSid, final CallMessage callMesssage);
4

5
     void onMessageSent(final String callSid, final String voiceEventSID);
6

7
     void onMessageFailure(final String callSid, final String voiceEventSID, final VoiceException error);
8
 }

• Fixed issue preventing execution on Android API 21-23 devices starting with version 6.3.0.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.
• The CallMessage.Builder.setContentType() API has no effect on the content type of the Call Message object. The content type always defaults to application/json .

June 3rd, 2024

• Programmable Voice Android SDK 6.6.1 [Maven Central] , [docs] MD5 Checksum : 8d5ef63fe22002d17209fbdd79b2c238

• Added new error code 31211 when sendMessage() API is invoked with a CallMessage object using the CallInvite object when the CallInvite is not reached the Ringing state yet. onMessageFailure() callback will be invoked in this case with the above mentioned error code.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

May 21st, 2024

• Programmable Voice Android SDK 6.6.0 [Maven Central] , [docs] MD5 Checksum : d4363792448280d85ff84c802186610a

• Call Message types (CallMessage.messageType) are treated as strings instead of enumerated values.
  • The SDK no longer validates CallMessage.messageType and acts as a pass through for unknown message types in both directions (messages received by the SDK and those sent by the SDK).
  • To send a user defined message, the sendMessage() API should be invoked with a CallMessage object where the messageType is set to one of the supported message types from [ https://www.twilio.com/docs/voice/sdks/call-message-events ]( https://www.twilio.com/docs/voice/sdks/call-message-events )
  • Added new error code 31210 for invalid call message type when sendMessage() API is invoked with a CallMessage object where the messageType is not set to user-defined-message .
• Added new Call Exception, InvalidPhoneNumberException that happens when a call is attempted with an invalid phone number id error 13224 .

• New constant-audio-output-level call quality warning added. This warning is triggered when the audio received is of a constant volume and can be used to determine when someone is speaking. Please note, if the remote party mutes the audio track or places the call on hold , this warning will still be raised.
• Metrics and events reported to Twilio Insights is now encoded via gzip to reduce transmission bandwidth.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

April 15th, 2024

• Programmable Voice Android SDK 6.5.1 [Maven Central] , [docs] MD5 Checksum : 99f789ccbd3c44b88417c0f38605cd72

• Increased sampling resolution of Voice Insights call quality metrics events.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Mar 12th, 2024

• Programmable Voice Android SDK 6.5.0 [Maven Central] , [docs] MD5 Checksum : 62c4f7e52e5af586ab6da62cbe7d9d0e

• A new AudioOptions API has been added, enabling audio processing operations on the local audio track/source.
  • Audio processing operations include Echo Cancellation, Automatic Gain Control, Noise Suppression, High Pass Filtering, setting jitter buffer max size in packets, and setting jitter buffer min delay in milliseconds (msec).
  • By default, all audio processing operations are enabled (set to true), the jitter buffer's maximum size is 200 packets, and the jitter buffer's minimum delay is 0 msec.
  • The default values can be modified and custom AudioOptions can be set as part of ConnectOptions when making outbound calls and/or as part of AcceptOptions when receiving incoming calls.
• Example of customized AudioOptions when making an outbound call - In this example, Automatic Gain Control and High Pass Filtering are disabled, jitter buffer max size is set to 100 packets and jitter buffer min delay is set to 5 msec.

1
connectOptions = new ConnectOptions.Builder(accessToken)
2
                    .iceOptions(iceOptions)
3
                    .audioOptions(new AudioOptions.Builder()
4
                        .autoGainControl(false)
5
                        .highpassFilter(false)
6
                        .audioJitterBufferMaxPackets(100)
7
                        .audioJitterBufferMinDelayMs(5)
8
                        .build())
9
                    .build();
10
Voice.connect(context, connectOptions, callListener);

• Example of customized AudioOptions when receiving an incoming call - In this example, Echo Cancellation and Noise Suppression are disabled, and jitter buffer max size is set to 50 packets.

1
acceptOptions = new AcceptOptions.Builder()
2
                    .iceOptions(iceOptions)
3
                    .audioOptions(new AudioOptions.Builder()
4
                        .echoCancellation(false)
5
                        .noiseSuppression(false)
6
                        .audioJitterBufferMaxPackets(50)
7
                        .build())
8
                    .build();
9
callInvite.accept(context, acceptOptions, callListener);

• The SDK publishes Voice Insights events when user-defined messages are sent, received, or when sending fails.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

The following table outlines the APK size impact for different Application Binary Interfaces (ABIs):

Feb 12th, 2024

• Programmable Voice Android SDK 6.4.1 [Maven Central] , [docs] MD5 Checksum : 0cd47c848842696ad6bcedab1db9615a

• Call.CallMessageListener methods have been updated to include the CallSid, which is a unique identifier for the Call or the CallInvite. The updated APIs are:

1
public interface CallMessageListener {
2

3
        void onMessageReceived(final String callSid, final CallMessage callMesssage);
4

5
        void onMessageSent(final String callSid, final String voiceEventSID);
6

7
        void onMessageFailure(final String callSid, final String voiceEventSID, final VoiceException error);
8

9
   }

• LogParameters class includes a Throwable field named tr . This allows us to log stack traces from Exceptions and other Throwable objects.
• LogParameters objects can now be constructed using LogParameters.Builder() that utilizes a builder pattern avoiding multi argument cumbersome direct constructors.
• The existing constructors for LogParameters have been deprecated in favor of construction using LogParamters.Builder() and will be removed in the next major release.

• Removed dead/unused c/c++ jni method, Java_com_twilio_voice_JniUtils_nativeJavaUtf16StringToStdString. This is somewhat related to github issue 572 .
• Added new Call Exception, InvalidCallerIdException that happens when a call is attempted with an invalid caller id error 13214 .
• Report the usage of Default Logger or Custom Logger to Twilio Insights. It only reports the type of Logger but not the actual log messages.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

Nov 30th, 2023

• Programmable Voice Android SDK 6.4.0 [Maven Central] , [docs] MD5 Checksum : ccb825d69416838d521692e99ff8e091

• Upgraded to use WebRTC-112.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

Nov 9th, 2023

• Programmable Voice Android SDK 6.3.3 [Maven Central] , [docs] MD5 Checksum : e6dd7df94fe8c83e3ed6765444742709

• The SDK now supports sending and receiving in-call user-defined messages. Use the Call::sendMessage(...) method to send messages. Endpoints subscribed to the events of the call will be receiving the messages. The CallMessageInterface::onReceiveMessage(...) callback will be raised to the application when a message is received by the client. Please visit this page for more details about this feature. Additionally, please see the following for more information on how to send and receive messages on the server. This feature is currently in Beta. Example below.

1
    private static class TestCallMessageObserver implements Call.CallMessageListener {
2
        @Override
3
        public void onMessageReceived(CallMessage callMesssage) {
4
            Log.d("[test]", "Call Message received");
5
        }
6
        @Override
7
        public void onMessageSent(String voiceEventSID) {
8
            Log.d("[test]", "Call Message:" + voiceEventSID + " sent");
9
        }
10
        @Override
11
        public void onMessageFailure(String voiceEventSID, VoiceException error) {
12
            Log.d("[test]", "Call Message: " + voiceEventSID + " failed to send: " + error.getMessage());
13
        }
14
    }
15
    .
16
    .
17
    .
18
    // register notification callbacks upon connect
19
    ConnectOptions cxnOptions = new ConnectOptions.Builder(accessToken))
20
                .callMessageListener(new TestCallMessageObserver())
21
                .build();
22
    Call call = Voice.connect(context, connectOptions, new Call.Listener() {...});
23
    .
24
    .
25
    .
26
    // send a message
27
    final CallMessage callMessage = (
28
        new CallMessage.Builder(CallMessage.MessageType.UserDefinedMessage))
29
        .contentType("application/json")
30
        .content((new JSONObject())
31
                .put("foo", "bar")
32
                .toString())
33
        .build();
34
    call.sendMessage(callMessage);
35
    .
36
    .
37
    .
38
    // receive call message before accpeting invite
39
    Voice.handleMessage(this, data, new TestCallMessageObserver());

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

Oct 2nd, 2023

• Programmable Voice Android SDK 6.3.2 [Maven Central] , [docs] MD5 Checksum : 40966f1d9fbece4a960b493a3a520725

• Adds a thread member to LogParameters class. The thread member contains the name (or id) of the thread where the log message was generated.

• Fixed a crash when the incoming call listener goes out of scope after timeout.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

Sept 5th, 2023

• Programmable Voice Android SDK 6.3.0 [Maven Central] , [docs] MD5 Checksum : a2e5f997dbf3c6b0e6b1a169e2cbf79d

• Provides a LoggerInterface interface. This interface contains a log method that is invoked with a LogParameters object every time a log message becomes available. The LogParameters object contains all the information relevant to the log message being delivered.
• The Android SDK internally implements the LoggerInterface to provide default logging capabilities to stdout using android.util.Log.
• Provides a Voice.SetLogger(LoggerInterface) method that allows setting a custom logger that conforms to LoggerInterface to which log messages will be delivered.
• Provides a Voice.GetLogger() method that returns the logger that was previously set with setLogger . If no custom logger was set, this method returns the default logger currently used by the SDK.
• Users can send their messages to be logged by the SDK using Voice.GetLogger().log(LogParameters) . This logs the message using the SDK's default logger.
• Users can also implement custom loggers that conform to LoggerInterface to customize the logging mechanism, for eg., logging to a file, sending the logs to a server, etc.
• The existing Logger class is deprecated and will be removed in the next major version release.

• Starting with SDK version 6.3.0, the required Android SDK version is 24 not 21. This issue is fixed as of SDK version 6.6.2.
• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

Size Report

June 23rd, 2023

• Programmable Voice Android SDK 6.2.1 [Maven Central] , [docs] MD5 Checksum : 8875d823f55cad837f972a700696be8b

Fixed a bug where the incoming call invite could only ring up to 3 minutes instead of the maximum 10 minutes call timeout.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

June 12th, 2023

• Programmable Voice Android SDK 6.2.0 [Maven Central] , [docs] MD5 Checksum : 5fd4d8b18a8cbfacc56c16a699080e8a

• Upgraded to use WebRTC-105.
• AudioOption, typing_detection is now deprecated, no longer supported by WebRTC.
• Fixed a crash when using an external audio device due to JAVA stack frame not being constructed.
• Fixed a crash due to file handle exhaustion.
• Fixed memory leaks regarding WebRTC shutdown & lingering Media Factory references.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

July 11th, 2022

• Programmable Voice Android SDK 6.1.2 [Maven Central] , [docs] MD5 Checksum : 1e9ce7d72f561c46711bbcdfa1df2873

• New edge umatilla is now supported. Set the Voice.setEdge(...) property before connecting or accepting the call.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

May 26th, 2022

• Programmable Voice Android SDK 6.1.1 [Maven Central] , [docs] MD5 Checksum : 355865e5f9e1f82be63af8225c4f0bfc

• Fixed a crash when the home region specifier ( twr ) in the access token is null .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

May 9th, 2022

• Programmable Voice Android SDK 6.1.0 [Maven Central] , [docs] MD5 Checksum : 164b77f552b7a2a9c8c40ace9b30077f

• The Voice Android SDK now supports Twilio Regional by providing the home region specifier in the access token header when calling the Voice.register() method, the Voice.unregister() method, or the Voice.connect() method.

Existing customers can now migrate their Voice use-cases to data centers in Ireland or Australia to establish data residency within the region. In addition, new customers may now select Ireland or Australia as their region of choice for Voice related use cases. There is no additional cost to use the new data centers in Ireland or Australia. To learn more about Regional Voice, check out our blog post or head over to our developer docs to get started.

Below is an example of specifying home region in the access token using the Twilio Node.js helper library:

1
const accessToken = new twilio.jwt.AccessToken(
2
    credentials.accountSid,
3
    credentials.apiKeySid,
4
    credentials.apiKeySecret, {
5
      identity,
6
      ttl,
7
      region: 'au1',
8
    },
9
  );

The decoded header of your access token should look like this:

1
{
2
  "alg": "HS256",
3
  "typ": "JWT",
4
  "cty": "twilio-fpa;v=1",
5
  "twr": "au1"
6
}

• The SDK compileSDKVersion and targetSDKVersion were updated to 31.
• Updated getStats(...) API doc.

• Fixed IceCandidatePairStats javadoc. Added responsesSent attribute to IceCandidatePairStats .

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

February 8th, 2022

• Programmable Voice Android SDK 6.0.7 [Maven Central] , [docs] MD5 Checksum : ddb5b1530276c8a5ceb2fc773a5e6dc7

• Upgraded SDK to build with Java 11.
• Updated the SDK to Android Gradle Plugin 7.0.4.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

November 19, 2021

• Programmable Voice Android SDK 6.0.2 [Maven Central] , [docs] MD5 Checksum : 9d3914d5b7cb05b9ded42611db408cd9

• Updated the SDK to Android Gradle Plugin 4.2.2.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

November 5, 2021

• Programmable Voice Android SDK 6.0.1 [Maven Central] , [docs] MD5 Checksum : 8be66d2ff2da31b89a5d904525a7b0a5

• Upgraded the SDK to use AndroidX.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

November 2, 2021

• Programmable Voice Android SDK 6.0.0 [Maven Central] , [docs] MD5 Checksum : c6150be451e4ad4948f2b5d2a7212ff0

• The minimum Android SDK version has been increased from 16 to 21.

• The voice SDK now validates full remote domain names while setting up the TLS connection.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

May 24, 2021

• Programmable Voice Android SDK 5.8.0 [Maven Central] , [docs] MD5 Checksum : dff5963249ff07f1378cd322fd50b50b

• This release is based on Chromium WebRTC 88.
• The SDK uses Unified Plan SDP semantics instead of Plan-B.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

March 29, 2021

• Programmable Voice Android SDK 5.7.2 [Maven Central] , [docs] MD5 Checksum : cac4a963814637b23e2d1ffadda30036

• Voice Android artifacts are now published to MavenCentral instead of Bintray.

  • Ensure to include mavenCentral() listed in your project's buildscript repositories section:

    Copy code block

    1
    buildscript {
    2
            repositories {
    3
                    mavenCentral()
    4
                    ...
    5
            }
    6
    }

• Voice Android SDK now publishes the checksum in the release notes.

• Fixed a crash when onNetworkChanged was called during the teardown process.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

March 11, 2021

• Programmable Voice Android SDK 5.6.3 [bintray] , [docs]

• Fixed a potential bug in the core module where the Logger could be accessed after being destroyed by another thread.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

January 26, 2021

• Programmable Voice Android SDK 5.6.2 [bintray] , [docs]

• Updated the SDK to Android Gradle Plugin to 4.1.1.

• Restrictive networks may fail unless ICE servers are provided via ConnectOptions.Builder.iceOptions(...) or AcceptOptions.Builder.iceOptions(...) . ICE servers can be obtained from Twilio Network Traversal Service .
• Occasional native crash in AsyncTask of registration/unregistration and event publishing. The crash has only been observed on API 18 devices and results from a thread safety bug in Android . Similar crashes have been reported in the popular networking library OkHttp #1520 #1338 . If this bug is impacting your applications, please open an issue on our quickstart and we will investigate potential fixes.

• Releases prior to 6.6.3 do not support Android 15 with 16k pages.

January 5, 2021

• Programmable Voice Android SDK 5.6.1 [bintray] , [docs]