This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
It's user-centric and team-centric: your app connects as a specific user or bot user on a specific team. Many apps will find the Events API's subscription model more scalable when working against multiple teams.
This method also returns a smorgasbord of data about the team, its channels, and members. Some times more information than can be provided in a timely or helpful manner.
The url property contains a WebSocket Message Server URL. Connecting to this
URL will initiate a Real Time Messaging session. These URLs are only valid for
30 seconds, so connect quickly!
The self property contains details on the authenticated user.
The team property contains details on the authenticated user's team. If a team has
not yet set a custom icon, the value of team.icon.image_default will be true.
The users property contains a list of user objects, one for every
member of the team.
The channels property is a list of channel objects, one
for every channel visible to the authenticated user. For regular or
administrator accounts this list will include every team channel. The
is_member property indicates if the user is a member of this channel. If
true then the channel object will also include the topic, purpose, member
list and read-state related information. The latest, unread_count, and unread_count_display attributes have been removed from this method's response. See this changelog entry.
The groups property is a list of group objects, one for
every group the authenticated user is in.
The mpims property is a list of mpims objects, one for
every group the authenticated user is in. MPIMs are only returned to the client
if mpim_aware is set when calling rtm.start. Otherwise, mpims are emulated
using the groups API.
The ims property is a list of
IM objects, one for every direct message channel visible to the
The bots property gives details of the integrations set up on this team.
This table lists the expected errors that this method could return.
However, other errors can be returned in the case where the service is down
or other unexpected factors affect processing. Callers should always
check the value of the ok params in the response.
Authentication token is for a deleted user or workspace.
The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.
The method was passed a PHP-style array argument (e.g. with a name like foo). These are never valid with the Slack API.
The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8iso-8859-1.
The method was called via a POST request with Content-Typeapplication/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/x-www-form-urlencodedmultipart/form-datatext/plain.
The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
The method was called via a POST request, but the POST data was either missing or truncated.
This table lists the expected warnings that this method will return.
However, other warnings can be returned in the case where the service
is experiencing unexpected trouble.
The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.
The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.