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

Installing the Chat Client SDKs


(error)

Danger

Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here(link takes you to an external page).

If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.

Twilio provides client-side Programmable Chat SDKs for browser-based web applications as well as for native iOS and Android applications.

(information)

Info

Intending to write back-end JavaScript with Twilio in Node.js to support your front-end client? Check out the Twilio Node.js SDK(link takes you to an external page).


JavaScript SDK

javascript-sdk page anchor

The latest version of the JavaScript SDK for Chat is available on Twilio's CDN. To include it on your web page, simply add the following <script> tag:


_10
<script src="https://media.twiliocdn.com/sdk/js/chat/v5.0/twilio-chat.min.js"></script>

The Twilio.Chat namespace will then be available in the window scope of your JavaScript application.

The JS Programmable Chat SDK is also available from NPM(link takes you to an external page).


The Android SDK is distributed as a direct download from Twilio's CDN. It can also be installed directly within a Gradle build file using Maven Central.

Direct Download

direct-download page anchor

Download the Programmable Chat Client library for Android from the Twilio CDN(link takes you to an external page).

Twilio Programmable Chat is available from Maven Central(link takes you to an external page).

To install via Gradle, include the following in your Gradle build file:


_13
allprojects {
_13
repositories {
_13
mavenCentral()
_13
}
_13
}
_13
_13
/**
_13
* Declare dependencies
_13
* @see http://www.gradle.org/docs/current/userguide/userguide_single.html#sec:how_to_declare_your_dependencies
_13
*/
_13
dependencies {
_13
implementation 'com.twilio:chat-android:7.0.1'
_13
}


The Programmable Chat SDK for iOS is available through the CocoaPods(link takes you to an external page) and Swift Package Manager(link takes you to an external page) dependency managers, or by direct download.

We ship .dSYM files which can assist in crash reporting for versions of Programmable Chat for iOS 2.3.2 and above. You can read more about integrating these dSYMs. If you use Google Firebase Crashlytics in your application, you are encouraged to perform these additional steps when integrating Programmable Chat.

To install the SDK using CocoaPods, add the following to your Podfile, changing MyTarget to the name of your target:


_10
source 'https://github.com/CocoaPods/Specs'
_10
_10
target 'MyTarget' do
_10
pod 'TwilioChatClient', '~> 5.0.1'
_10
end

To install the SDK with Swift Package Manager, add the following dependency to your project:


_10
https://github.com/twilio/twilio-chat-ios

  1. Open your project in Xcode.
  2. Select File > Swift Packages > Add Package Dependency... .
  3. Enter https://github.com/twilio/twilio-chat-ios into the search field in the Choose Package Repository dialog, then click Next .
  4. Make your versioning choice and click Next .
  5. Add the package to one of your targets and click Finish .

We also offer the SDK for direct download if your project does not use CocoaPods or Swift Package Manager. To add Programmable Chat to your project, download the Chat Client framework(link takes you to an external page).

  1. Expand the .zip file.
  2. Locate the .xcframework file(s) inside the directory created.
  3. Drag the .xcframework file(s) into your project, making sure they are dropped in the Embedded Binaries section of your project target's settings. Select Copy items if needed when prompted. If the framework files do not appear in the Embedded Binaries for your target, you will receive a Reason: image not found error during compilation.
  4. In the target's Linked Frameworks section, add libc++.tbd as a dependency if it is not already there.
(information)

Info

You will need to repeat these steps to add a Run Script step that calls remove_archs for Twilio AccessManager if you are using it in your project too.


Demo and reference client applications

demo-and-reference-client-applications page anchor

A demo client implementation for each of the SDKs is available freely via GitHub. These are updated to use the latest SDK versions and implement almost all the available functionality. These implementations are intended for reference purposes only.

PlatformDemo App
JavaScripthttps://github.com/twilio/twilio-chat-demo-js(link takes you to an external page)
iOShttps://github.com/twilio/twilio-chat-demo-ios(link takes you to an external page)
Androidhttps://github.com/twilio/twilio-chat-demo-kotlin(link takes you to an external page)

Additional third-party bindings and reference implementations are available for the following frameworks.


Rate this page: