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

Working with Conversations


A Conversation is a distinct omni-channel messaging thread (i.e. a place where users from multiple channels can exchange messages), in which Participants from any channel Conversations supports (e.g. SDK, SMS, WhatsApp) can communicate with each other.

You can create and manage new Conversations using either the Conversations REST API or the client-side Conversations SDK (what we're covering here). Let's start to dive in!


Create your first Conversation

create-your-first-conversation page anchor

You'll create a new Conversation using the Conversation creation (JS, iOS) or Conversation Builder methods on your new initialized Client object. Optionally, you can pass in the following parameters:attributes, friendlyName, and uniqueName.

Create Conversation

create-conversation page anchor
Node.js
Typescript

_10
/* Creating Conversation */
_10
_10
// create new conversation, all the parameters are optional
_10
await client.createConversation({
_10
attributes: {},
_10
friendlyName: "new conversation",
_10
uniqueName: "new conversation",
_10
});


Join or Leave a Conversation

join-or-leave-a-conversation page anchor

After creating the Conversation, you'll need to join it to participate. Joining will create a Participant object in the Conversation that is associated with your User. This also subscribes you to events from the Conversation.

If you'd like to stop receiving events from this Conversation and remove your Participant, you can call the appropriate method to leave the Conversation.

Join or Leave a Conversation

join-or-leave-a-conversation-1 page anchor
Node.js
Typescript

_10
//join the Conversation
_10
await conversation.join();
_10
_10
//leave the Conversation
_10
await conversation.leave();


There are two types of Participants:

  • Chat (SDK-based) Participants, or
  • Non-chat (e.g. SMS, WhatsApp) Participant

SDK-based (chat) Participant objects have a many-to-one relationship with User objects. A User represents a human using the SDK, and that User can be associated with multiple Participant objects: a unique Participant object for each Conversation they are participating in. In contrast, non-chat Participants (i.e. SMS, WhatsApp, etc.) are not linked by a User object even when they are the same human participating in multiple Conversations.

Add chat participant (user)

add-chat-participant-user page anchor

Users are uniquely identified by the identity property in the Access Token they initialized their Client with. You can create a Chat Participant belonging to that User in the Conversation by specifying their User's identity in the corresponding creation method.

Add non-chat participant

add-non-chat-participant page anchor

To add a non-chat Participant to the Conversation, you'll have to pass the proxyAddress and address parameters to the specific creation method on the Conversation object. The proxyAddress parameter is a Twilio address (e.g. Twilio phone number, WhatsApp sender) and the address parameter is the real-world phone number or address that the non-chat Participant is using.

The following code sample shows how to add both chat and non-chat Participants to a conversation.

Node.js
Typescript

_17
/* Adding Participants (chat and non-chat) */
_17
_17
// add chat participant to the conversation by its identity
_17
await conversation.add("identity");
_17
_17
// add a non-chat participant to the conversation
_17
const proxyAddress = "+11222333";
_17
const address = "+12345678";
_17
await conversation.addNonChatParticipant(proxyAddress, address);
_17
_17
// adds yourself as a conversations sdk user to this conversation
_17
// use after creating the conversation from the SDK
_17
await conversation.join();
_17
_17
conversation.on("participantJoined", (participant) => {
_17
// fired when a participant has joined the conversation
_17
});


You can get the list of all Participants within the Conversation by invoking the corresponding method on the Conversation object.

Node.js
Typescript

_10
/* Get participants of the conversation */
_10
_10
let participants = await conversation.getParticipants();


To list the latest messages of a Conversation, call the appropriate method on the Conversation object and optionally specify the index of a specific Message to start from.

There are a few options, you can review the auto-generated documentation to familiarize yourself with the parameters you can use to modify this behavior.

Node.js
Typescript

_11
/* get the latest messages of the conversation. optional arguments:
_11
pageSize | 30,
_11
anchor | "end",
_11
direction | "backwards"
_11
*/
_11
_11
// get the messages paginator the latest 30 messages
_11
let messagesPaginator = await conversation.getMessages(30, 0, "backwards");
_11
_11
// get messages
_11
const messages = messagesPaginator.items;


Because all Conversations are private, listing Conversations will only return Conversations that you are participating in. Call the appropriate method to retrieve them.

Node.js
Typescript

_10
// get the conversations paginator
_10
let conversationsPaginator = await client.getSubscribedConversations();
_10
_10
// get conversations
_10
const conversations = conversationsPaginator.items;


Well done! You've just learned how to create your first Conversation, add a Participant and list your conversations. To learn more, check out these helpful links:


Rate this page: