Installing the Chat Client SDKs

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

<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.

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.

Download the Programmable Chat Client library for Android from the Twilio CDN.

Twilio Programmable Chat is available from Maven Central.

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

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

7
/**
8
 * Declare dependencies
9
 * @see http://www.gradle.org/docs/current/userguide/userguide_single.html#sec:how_to_declare_your_dependencies
10
 */
11
dependencies {
12
    implementation 'com.twilio:chat-android:7.0.1'
13
}

The Programmable Chat SDK for iOS is available through the CocoaPods and Swift Package Manager 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:

1
source 'https://github.com/CocoaPods/Specs'
2

3
target 'MyTarget' do
4
  pod 'TwilioChatClient', '~> 5.0.1'
5
end

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

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.

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.

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.

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