Skip to main content

Messaging

Welcome to the latest version of the RELAY SDK

In May 2022, Messaging was incorporated into the latest version of the RELAY Realtime Server SDK. If you have an application that runs on the previous version of RELAY for Messaging, consider upgrading to the latest. For some pointers on migrating to this new version, please read our post "Upgrade Your RELAY Game".

Access the Messaging API. You can instantiate a Messaging.Client to send or receive SMS and MMS. Please check Messaging Events for the full list of events that a Messaging.Client can subscribe to.

Example

The following example listens for incoming SMS messages over an "office" topic, and also sends an SMS.

import { Messaging } from "@signalwire/realtime-api";

const client = new Messaging.Client({
project: "<project-id>",
token: "<api-token>",
topics: ["office"],
});

client.on("message.received", (message) => {
console.log("message.received", message);
});

await client.send({
from: "+1xxx",
to: "+1yyy",
body: "Hello World!",
});

Classes