Product Overview

The SignalWire Chat API is a flexible IP Message Bus that you can use to send and receive messages.

Chat is an extension of our PubSub feature which has two main components:

  • Channels
  • Messages

In a PubSub environment, messages are published to a channel and the new message event is available to any subscribers. This means the publishers and subscribers are isolated and do not need to know where the messages are coming from or being read. If this sounds like the messaging model that meets your needs, check out our PubSub service!

  • The REST API allows you to create chat tokens.
  • The Browser SDK will help you integrate PubSub into your web app.
  • The Server-side RELAY Realtime SDK allows you to manage subscriptions and listeners.

Our Chat feature adds another main component: Members.
You can create channels, members can subscribe to those channels, and they can send attributed messages that every other subscriber will be able to see. Members can even carry state. If this model better suits your needs, Chat is for you!

  • The REST API allows you to create chat tokens.
  • The Browser SDK allows you to integrate Chat features into any web app.
  • The RELAY Realtime Server SDK allows you to keep track of Chat events, manage members/subscriptions, and send messages to a particular channel.

Common Chat FAQs

Question

Answer

Can Chat only send and receive messages?

Chat can be used to send and receive any JSON-serializable object, so not just messages.

Does Chat support group chats?

Yes! Channels are essentially group chats that members can join and exchange messages in.
If you intend to create group chats that use SMS as well, please read the next frequently asked question.

Does Chat support sending/receiving via SMS?

While Chat does not support sending/receiving via SMS by default, using RELAY Realtime SDK along with our Messaging API you can add SMS support (or any other format of communication) to it!

Can we use Chat to build a chatbot?

Yes! You can use Chat along with Dialogflow to create chatbots according to your needs.

Can Chat messages be logged?

Using RELAY Realtime Server SDK you can listen for the "message" event and log each message accordingly.

Sign Up Here

Get started by creating a SignalWire account and space here.

Please feel free to reach out to us on our Community Slack or create a Support ticket from your Dashboard if you need guidance!


Did this page help you?