subscribe | SignalWire

subscribe(channels): Promise<void>

List of channels for which you want to receive messages. You can only subscribe to those channels for which your token has read permission.

Note that the subscribe function is idempotent, and calling it again with a different set of channels will not unsubscribe you from the old ones. To unsubscribe, use unsubscribe.

Parameters

channels

string | string[]Required

The channels to subscribe to, either in the form of a string (for one channel) or an array of strings.

Returns

Promise<void>

Example

1 const pubSub = new PubSub.Client({
2   token: "<your chat token>"
3 });
4 
5 pubSub.on("message", (m) => console.log(m));
6 
7 await pubSub.subscribe("my-channel");
8 await pubSub.subscribe(["chan-2", "chan-3"]);