Conversations

A single conversation

GET returns a single Conversation or an HTTP 404 status if no conversation exists for the given conversation ID.

PUT creates or updates a conversation.

GETPUT/v1/{appId}/conversations/{conversationId}

Example url: /v1/q3k1pa9d/conversations/order_fc_491731

Setting conversation data

You can use a PUT request method to create a conversation or to update (a subset of) conversation attributes.

To update conversation details, you only need to send the subset of fields you want to update. In that respect, even though you update a conversation with an HTTP PUT request method, the user update acts similar to an HTTP PATCH request method.

PUT/v1/{appId}/conversations/{conversationId}
1type ConversationId = string;
2type UnixMilliseconds = number;
3

4type RequestBody = {
5  participants?: Array<string>,
6  subject?: string | null,
7  welcomeMessages?: Array<string> | null,
8  custom?: Map<string, string> | null,
9  photoUrl?: string | null
10}

PUT merges data with existing data, if any. For example, you cannot remove participants from a conversation by PUTing a list of participants that excludes some existing participants. If you want to remove participants from a conversation, use the Participation endpoint.

Getting created conversations

After you successfully create or update a conversation, you can fetch it back with a GET REST call.

GET/v1/{appId}/conversations/{conversationId}
1type ConversationId = string;
2type UnixMilliseconds = number;
3

4type Conversation = {
5  id: ConversationId;
6  subject: string | null;
7  photoUrl: string | null;
8  welcomeMessages: string[] | null;
9  custom: { [name: string]: string };
10  lastMessage: Message | null;
11  participants: {
12    [id: UserId]: {
13      access: 'ReadWrite' | 'Read';
14      notify: boolean | 'MentionsOnly';
15      isUnread: boolean;
16    };
17  };
18  createdAt: UnixMilliseconds;
19  topicId: string;
20};

Deleting a conversation

Use this endpoint to irrevocably delete data for a certain conversationId. All the data and metadata linked to the conversation will be deleted. Here is the list of things that will happen:

  1. All messages in the conversation will be deleted.
  2. Participants will not be a part of the conversation anymore.
  3. All the conversation metadata will be erased.
  4. Active UIs will display a "Chat not found" screen (which is localized).
  5. The conversation gets removed from all (former) participants' Inbox feeds.

NOTE: Users that take part in the conversation WILL NOT be deleted.

DELETE/v1/{appId}/conversations/{conversationId}

Marking a conversation as read or unread

This endpoint is used to mark a conversation as read or unread for a specific user.

Setting the isUnread parameter to true marks the conversation as unread; setting the isUnread parameter to false marks the conversation as read, and omitting the isUnread parameter, or setting it to null does not change the read/unread status of the conversation.

Marking a conversation as read will also mark any messages within the conversation as read by that user, but marking a conversation as unread will not change the read/unread status of any message within the conversation.

PATCH/v1/{appId}/users/{userId}/conversations/{conversationId}
1{
2  isUnread?: boolean | null,
3}

Listing all conversations in the application

This lists all conversations ever created in your TalkJS application. This request is paginated as explained here. The response has a data field with an array of Conversation objects as described above.

GET/v1/{appId}/conversations
1{
2  "data": Array<Conversation>
3}

Ordering

Ordering is available since API version 2021-02-09

Default order in versions before 2021-02-09 is createdAt DESC and cannot be changed

By default, conversations are returned in the order of the last activity in them, latest first. You can change the order by using orderBy and orderDirection query parameters. Conversations can either be sorted on a creation date or on the last activity in that conversation. Ordering conversations by the creation date can be useful when you want stable sorting.

Following values are accepted in orderBy query parameter:

  • lastActivity (default): sort by last activity timestamp
  • createdAt: sort by date of creation

Following values are accepted in orderDirection query parameter:

  • DESC (default): descending order
  • ASC: ascending order

Pagination

offsetTs is available since API version 2021-02-09

Conversations can be paginated, as any other listing handle. You can request at most 30 conversations at once.

Using startingAfter requires passing in a conversation ID, whereby results will start with the conversation right after the selected one in the current sort order. It works with all currently supported sorting options.

Another option is to use offsetTs which accepts a timestamp and offsets the results according to the sort order. This might be more useful when used in conjunction with lastActivity sorting since conversations can move to the front of the list as new messages come, and using one of the conversations as a pointer can yield unexpected results.

Filtering conversations

By the last message's timestamp

It is possible to filter conversations by when the last message was sent to the conversation using the lastMessageBefore and lastMessageAfter filters.

lastMessageBefore and lastMessageAfter should be Unix timestamps expressed in milliseconds.

For example, the following query string parameters get conversations where the last message was sent between the Unix timestamps 1701700000000 and 1702000000000:

1?lastMessageAfter=1701700000000&lastMessageBefore=1702000000000

By custom filters

TalkJS also supports filtering by various fields. The filter interface is precisely the same as the JavaScript SDK's Conversation Filter. In order to filter conversations by a custom filter you need to URLencoded the JSON formatted filter.

You can use your favorite programming language to generate the conversation filter in the required JSON structure.

NodeJS example:

1const filter = { custom: { category: ['==', 'shoes'] } };
2const encodedFilter = encodeURIComponent(JSON.stringify(filter));
3const res = await fetch(
4  `https://api.talkjs.com/v1/${appId}/conversations?filter=${encodedFilter}`
5);
6const conversations = await res.json();

Filters can be combined together with limits and cursors.

Examples

1GET https://api.talkjs.com/v1/{appId}/conversations
2GET https://api.talkjs.com/v1/{appId}/conversations?lastMessageBefore=1521522849308&lastMessageAfter=1421522849732
3GET https://api.talkjs.com/v1/{appId}/conversations?limit=30&lastMessageAfter=1421522849732
4GET https://api.talkjs.com/v1/{appId}/conversations?startingAfter=c_21
5

6// URL encoded version of the filter {"custom":{"category":["==","shoes"]}
7GET https://api.talkjs.com/v1/{appId}/conversations?filter=%7B%22custom%22%3A%7B%22category%22%3A%5B%22%3D%3D%22%2C%22shoes%22%5D%7D%7D

Filtering by user

The Users resource lets you list the conversations a specific user is a part of.

Deprecated Marking a conversation as read

NOTE: This endpoint is deprecated. Please use the endpoint described in the previous section instead.

POST/v1/{appId}/conversations/{conversationId}/readBy/{userId}
1{}