Starts a Real Time Messaging session.

Optional Params

• batch_presence_aware - Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence. ex: 1
• presence_sub - Only deliver presence events when requested by subscription. See presence subscriptions.

Errors the API can return:

• migration_in_progress - Team is being migrated between servers. See the team_migration_started event documentation for details.

See the Common Errors guide for errors returned by every Web API method.

Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.

Optional Params

• batch_presence_aware - Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence. ex: 1
• include_locale - Set this to true to receive the locale for users and channels. Defaults to false
• mpim_aware - Returns MPIMs to the client in the API response.
• no_latest - Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets no_unreads to 1 ex: 1
• no_unreads - Skip unread counts for each channel (improves performance).
• presence_sub - Only deliver presence events when requested by subscription. See presence subscriptions.
• simple_latest - Return timestamp only for latest message object of each channel (improves performance).

Errors the API can return:

• 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.

See the Common Errors guide for errors returned by every Web API method.