Chat Client

View as Markdown

The Chat Client enables real-time messaging between users. Access it via the chat property on a SignalWire Client.

1import { SignalWire } from "@signalwire/realtime-api";
2
3const client = await SignalWire({ project: "<project-id>", token: "<api-token>" });
4const chatClient = client.chat;

Use subscribe() to join channels, publish() to send messages, and listen to receive events. See Events for all available events.

Examples

Listening for messages

1await chatClient.listen({
2 channels: ["general", "support"],
3 onMessageReceived: (message) => {
4 console.log(`${message.channel}: ${message.content}`);
5 }
6});

Publishing messages

1await chatClient.publish({
2 channel: "general",
3 content: "Hello, world!",
4});