Skip to main content
Sameroom: Sameroom Commands
8x8 Support

Sameroom: Sameroom Commands

Overview

Tubes require two Sameroom-enabled chat rooms that you wish to connect. You can connect two rooms within one chat application, or between two different chat applications.

Below is a list of available Sameroom commands, and how to use them to create and manage tubes.

Notes:

  • Sameroom commands and responses are not relayed across your tube network—they are visible only in the room they are sent from.
  • Some chat applications such as Slack and 8x8 Work require the use of @Sameroom instead of
    -sameroom to invoke commands.

Applies To

  • Sameroom standalone service
  • 8x8 Team Messaging

Sameroom Commands

  • Help: Displays a list of all of the available Sameroom commands.
  • Ping: Tests your tube network by sending a request for a response to all connected tubes.
  • Map: Creates a link to a graphical map of all rooms in your tube network.
  • Open: Similar to Portal, Open generates a two-minute code used with Connect to create a tube between rooms.
  • Portal: Generates a unique, permanent URL used with Connect to create a tube between rooms.
  • Connect: Used together with the Open code or Portal URL to connect a tube between rooms.
  • Disable: Deletes all tubes directly connected to the room that the command is issued from.
  • Format:
  • ^^^: The Hush command (placed before a message) tells Sameroom to post the message only to the current room.

Help

Command: -sameroom help

Expected output:

[Sameroom] Available commands (see https://sameroom.io/faq for more info):
 ^^^ <message> -- Post <message> to your side of Tube only (hush command)
 -sameroom ping -- Ping all connected rooms
 -sameroom map -- Show map of all connected rooms
 -sameroom disable -- Delete all Tubes connected to a room
 -sameroom format -- Show the current posting format for a room
 -sameroom format <format option> -- Set posting format for a room
 (see https://sameroom.io/blog/introducing-posting-options for details). <format option> can be one of the following: off, dispname, username, dispname team, username team, dispname username, dispname username team
 -sameroom portal -- Generate a Portal URL
 -sameroom open -- Initiate a connection. Return a code to be used with -sameroom connect
 -sameroom connect <code> -- Create a Tube to room where code was issued by -sameroom open
 -sameroom connect <Portal URL> -- Create a Tube via the Portal URL issued by -sameroom portal

Ping

The Ping command tests your tube network by sending a request for a "pong" response from all connected tubes.

Command: -sameroom ping

Example output:

[Sameroom] Pong from Town Crier on Cisco Spark via relay@sameroom.io
[Sameroom] Pong from Town Crier on Cisco Jabber via relay@corp.sameroom.io
[Sameroom] Pong from Town Crier on Microsoft Lync 2013 via relay@corp.sameroom.io

Map

Map creates a link to a graphical representation of all connected rooms in your tube network.

Map URLs are valid for 24 hours, after which you must re-run the map command if a new map is needed.

Command: -sameroom map
Example Response: [Sameroom] Forwarding over 3 tube(s) between 4 room(s): map

Below is an example of a map:

clipboard_e5730c53d902d1ac550acc23d42691ae2.png

Open

The Open command creates one side of a tube, and provides a connect-code which will expire in two minutes.

You would then use that code together with the Connect command to complete your tube connection to another room. This is good for security, because the code cannot be re-used once it expires.

In room A:

Use the Open command on room A to generate a two-minute code. Then use the Connect command in room B (see below) to complete your tube connection.

Command: -sameroom open
Response: Your code is ABCDE

Connect (using an Open code)

In room B:

Use the Connect command to complete the tube connection to the room where you created the code (room A).

Command: -sameroom connect ABCDE
Response: [Connection confirmation, listing of connected rooms, and a map link]

Portal

The Portal command generates a unique, permanent URL used with Connect to create a tube between rooms. The limit to the number of tubes you can create using the URL is governed only by your Sameroom service plan.

A Portal URL can be re-used any number of times, unless it is explicitly deleted. This is inherently less secure than implementing the Open code, but allows for easier administration of multiple room connections.

Generate your Portal URL in room A, and then use the Connect command in room B (see below) to complete your tube connection.

In room A:

Command: -sameroom portal
Response: Your Portal URL is https://sameroom.io/aBcDeFGh -- you can send the URL to someone on a different team to share this room. Note: you can connect more than two teams this way.

Connect (using a Portal URL)

Use the Connect command in room B to complete the tube connection to the room where you created the Portal URL (room A).

In room B:

Command: -sameroom connect https://sameroom.io/aBcDeFGh
Response: [Connection confirmation, listing of connected rooms, and a map link]

Disable

This command is handy if you need to stop relaying messages to/from a room but can’t find the person who created the tube(s) (or don’t know who did it).

All tubes directly connected to the room where the Disable command is run will be deleted.

Note that Portals created from BridgeBots cannot be deleted.

Command: -sameroom disable
Expected Response: OK

Format

Format simply governs how your messages look when they are posted, and may be dependent on the specific chat application.

For more info, see Posting Options.

Show Posting Format

Show the current message display format.

Command: -sameroom format
Example Response: [Sameroom] Format: Display Name, Team

Set Posting Format

Tell Sameroom how you want your messages to be displayed in your chat room.

Available options are:

  • off
  • dispname
  • username
  • dispname team
  • username team
  • dispname username
  • dispname username team

For more info, see Posting Options.

Command: -sameroom format <option>

Example:

Command: -sameroom format dispname username team
Response: [Sameroom] Format: Display Name (Username), Team

^^^: Hush

When the Hush command ^^^ is placed before a message, Sameroom will ignore all tube connections when the message is posted. This keeps a single message confined to the room it's posted in.

  • The hush command ^^^ must be followed by a space character for Sameroom to properly recognize it.
  • Replies to a hushed post are not hushed unless the reply is also sent using the Hush command.
  • You can also use the @[name] mention to bring the message to the attention of a specific teammate.
Example Command: ^^^ @alice, plz take a look
  • Was this article helpful?