Start a Real Time Messaging session | Sample

3 parameters

tokenstringrequired

Authentication token with the `rtm:stream` scope.

batch_presence_awarebooleanoptional

Enable batched presence deliveries through subscriptions; this changes the shape of `presence_change` events.

presence_subbooleanoptional

Deliver presence events only when requested through a presence subscription.

2 status codes

200Returns the Real Time Messaging session URL, the connected team, and the authenticated user's identifier and name.

okbooleanrequired

Allowed:true

selfobjectrequired

teamobjectrequired

urlstringrequired

defaultTypical error response

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:not_authedinvalid_authaccount_inactivetoken_revokedno_permissioninvalid_arg_nameinvalid_array_arginvalid_charsetinvalid_form_datainvalid_post_typemissing_post_typeteam_added_to_org

okbooleanrequired

Allowed:false

Error handling

The token must grant the rtm:stream scope. If batch_presence_aware is enabled, presence-change events use the batched format; presence_sub limits presence events to requested subscriptions.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.rtmConnect.list({
  token: "sk_live_4eC39Hq",
  batchPresenceAware: "example",
  presenceSub: "example",
});

{
  "ok": true,
  "self": {
    "id": "U4X318ZMZ",
    "name": "robotoverlord"
  },
  "team": {
    "domain": "slackdemo",
    "id": "T2U81E2FP",
    "name": "SlackDemo"
  },
  "url": "wss://..."
}

Request

Response

Errors