publish | SignalWire

Publish a message into the specified channel.

Parameters

objectRequired

Configuration object for publishing a message

stringRequired

Channel in which to send the message.

anyRequired

The message to send. This can be any JSON-serializable object or value.

params.meta

Record<any, any toc={true}>

Metadata associated with the message. There are no requirements on the content of metadata.

Promise<void>

Publishing a message as a string:

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

Publishing a message as an object:

1 await chatClient.publish({
2   channel: "my-channel",
3   content: {
4     field_one: "value_one",
5     field_two: "value_two",
6   },
7 });