Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods rtm.start.json
Raw

priv/docs/methods/rtm.start.json

{
"args": {
"batch_presence_aware": {
"default": "false",
"desc": "Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See batch presence.",
"example": "1",
"required": false,
"type": "boolean"
},
"include_locale": {
"desc": "Set this to `true` to receive the locale for users and channels. Defaults to `false`",
"required": false,
"type": "boolean"
},
"mpim_aware": {
"desc": "Returns MPIMs to the client in the API response.",
"required": false,
"type": "boolean"
},
"no_latest": {
"default": "0",
"desc": "Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1`",
"example": "1",
"required": false,
"type": "boolean"
},
"no_unreads": {
"desc": "Skip unread counts for each channel (improves performance).",
"required": false,
"type": "boolean"
},
"presence_sub": {
"default": "true",
"desc": "Only deliver presence events when requested by subscription. See presence subscriptions.",
"required": false,
"type": "boolean"
},
"simple_latest": {
"desc": "Return timestamp only for latest message object of each channel (improves performance).",
"required": false,
"type": "boolean"
}
},
"desc": "Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.",
"errors": {
"migration_in_progress": "Workspace is being migrated between servers. See the `team_migration_started` event documentation for details.",
"rtm_connect_required": "`rtm.start` is deprecated. Please use `rtm.connect` instead of `rtm.start`. Read https://docs.slack.dev/changelog/2021-10-rtm-start-to-stop for more info."
},
"rate_limit": {
"label": "Tier 1: 1+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {}
}