As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. A corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:.
This Conversations API method opens a multi-person direct message or just a 1:1 direct message.
Provide 1 to 8 user IDs in the user parameter to open or resume a conversation. Providing only 1 ID will create a direct message. Providing more will create an mpim.
If there are no conversations already in progress including that exact set of members, a new multi-person direct message conversation begins.
Subsequent calls to conversations.open with the same set of
users will return the already existing conversation.
Authentication token bearing required scopes.
Resume a conversation by supplying an im or mpim's ID. Or provide the users field instead.
Boolean, indicates you want the full IM channel definition in the response.
Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.
This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.
Response structure is altered by providing return_im parameter. When set to false, the default, just a conversation's ID is returned. When set to true, the entire conversation object is returned.
Typical success response
Passing return_im will expand the response to include more info about a conversation
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.
Value passed for channel was invalid.
Value(s) passed for users was invalid.
The calling user is restricted from seeing the requested user.
A specified user has been disabled.
Missing users in request
Needs at least 2 users to open
Needs at most 8 users to open
This type of conversation cannot be used with this method.
The calling token is not granted the necessary scopes to complete this operation.
No authentication token provided.
Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
Authentication token is for a deleted user or workspace.
Authentication token is for a deleted user or workspace or the app has been removed.
The workspace token used in this request does not have the permissions necessary to complete the request.
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.
The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
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.
Slack did nothing when serving this request but it did not fail.
The conversation was already open so Slack did nothing.
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.