Chat Namespace

The Chat namespace includes methods that allows you to send and receive chat messages.

The ConversationChatMessage object

ConversationChatMessage objects represent the specific interactions that have taken place in the Chat:

• id: A unique identifier for the conversation message.
• conversation_id: A unique identifier of the parent conversation.
• user_id: A unique identifier for the subscriber.
• ts: The timestamp, in Unix Epoch, when the message was created.
• details: Additional metadata associated with the conversation.
• type: The type of the conversation message.
• subtype: The subtype of the conversation message.

Here is an example of a ConversationChatMessage object:

1
{
2
  "id": "3c114417-5cc0-4d03-a30f-c90659028d73",
3
  "conversation_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
4
  "user_id": "cecbe021-ff86-4ac6-bdf3-399ca477ad6f",
5
  "ts": 1708192187.6779745,
6
  "details": {},
7
  "type": "message",
8
  "subtype": "log"
9
}

Methods

getMessages

• getMessages(options): Promise<{ data: ConversationChatMessage[], hasNext, hasPrev, nextPage(), prevPage() }>

Returns the list of chat messages for a given addressId.

Parameters

Returns

Promise<{ data: Address[], hasNext, hasPrev, nextPage(), prevPage() }>

Example

1
await client.chat.getMessages({ addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4" });

subscribe

• subscribe(options): {cancel()}

Returns a list of Addresses.

Parameters

Returns

An object will be returned with a cancel() function which can be used to unsubscribe to the event.

Example

1
const { cancel } = await client.chat.subscribe({
2
  addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
3
  onMessage(msg) {
4
    console.log(msg);
5
  },
6
});
7
8
cancel();

sendMessage

• sendMessage(options): Promise<Conversation>

Send a Chat Message to a given Address ID. If no Conversation exists with that Address ID, one will be created. This is the same function as conversation.sendMessage.

Parameters

Example

1
await client.chat.sendMessage({
2
  addressId: "12345",
3
  text: "Hello from SignalWire!",
4
});

join

• join(options): Promise<JoinConversationResponse>

Joins a conversation given an address without having to send a message. Does nothing if you were already joined to the conversation. This is the same function as conversation.join.

You automatically join a conversation when you send the first message to an address. The join method allows you to join a conversation without first sending a message.

Parameters

Example

1
await chat.join({
2
  addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
3
});