/rtm.connect

GET

/rtm.connect

Starts a Real Time Messaging session.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://slack.com/api/rtm.connect?token='

Response Example

200 - response

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

Request

Query Params

token

string

required

Authentication token. Requires scope: rtm:stream

batch_presence_aware

string

optional

Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

presence_sub

string

optional

Only deliver presence events when requested by subscription. See presence subscriptions.

Responses

🟢200Typical success response

application/json

Body

Schema for successful response from rtm.connect method

enum<boolean>

required

Allowed value:

true

self

object

required

string

required

Match pattern:

^[UW][A-Z0-9]{2,}$

name

string

required

team

object

required

domain

string

required

string

required

Match pattern:

^[T][A-Z0-9]{2,}$

name

string

required

url

string <uri>

required

🔴500Typical error response

Modified at 2023-08-15 05:39:46

/reminders.list

/search.messages