Twilio Conversations client library

Twilio Conversations: Create meaningful connections with customers across various communication channels. Visit our official site for more detalis: https://www.twilio.com/conversations

Instantiating and using

To use the library you need to generate a token and pass it to the conversations Client create factory.

NPM

npm install --save @twilio/conversations

Using this method, you can require twilio-conversations and then use the client:

const { Client } = require('@twilio/conversations');
const client = new Client(token);
// Before you use the client, subscribe to the `'stateChanged'` event and wait 
// for the `'initialized'` state to be reported.
client.on('stateChanged', (state) => {
  if (state === 'initialized') {
    // Use the client
  }
}

The SDK could also be imported using the ES module syntax:

import { Client } from '@twilio/conversations';
const client = new Client(token);
// Before you use the client, subscribe to the `'stateChanged'` event and wait 
// for the `'initialized'` state to be reported.
client.on('stateChanged', (state) => {
  if (state === 'initialized') {
    // Use the client
  }
}

CDN

Releases of twilio-conversations.js are hosted on a CDN, and you can include these directly in your web app using a <script> tag.

<script src="https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js"></script>

Using this method, twilio-conversations.js will set a browser global Twilio.Conversations through which you can use the client :

Twilio.Conversations.Client.create(token).then(client => {
    // Use client
});

or, if you prefer async/await syntax:

let client = await Twilio.Conversations.Client.create(token);
// Use client

Security

The CDN consumption described above allows you to consume latest bug fixed versions automatically, but does not prevent from detecting malicious modifications in the SDK code.

If you require more security you will have to consume SDK by using SRI and using an exact version number. While less flexible it is significantly more secure, which is required by some applications.

To consume securely use the following script snippet format:

<script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.0/twilio-conversations.min.js"
        integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
        crossorigin="anonymous"></script>

Find the hash of each release published on the Changelog page.

Supported Browsers

Browser	Supported Versions
Chrome for Android	94
Firefox for Android	92
UC Browser for Android	12.12
Chrome	94, 93, 92
Edge	94, 93, 92
Firefox	93, 92, 91
Internet Explorer	11
Safari for iOS	15, 14.5-14.8
Safari	15, 14.1, 14
Samsung Internet	15.0, 14.0

Changelog

See this link.