Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods conversations.open.json
Raw

priv/docs/methods/conversations.open.json

{
"args": {
"channel": {
"desc": "Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.",
"required": false
},
"prevent_creation": {
"desc": "Do not create a direct message or multi-person direct message. This is used to see if there is an existing dm or mpdm.",
"required": false,
"type": "boolean"
},
"return_im": {
"desc": "Boolean, indicates you want the full IM channel definition in the response.",
"required": false,
"type": "boolean"
},
"users": {
"desc": "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`.",
"required": false,
"type": "string"
}
},
"desc": "Opens or resumes a direct message or multi-person direct message.",
"errors": {
"channel_not_found": "Value passed for `channel` was invalid.",
"invalid_user_combination": "All external people must already be in at least one channel together to send a message.",
"method_not_supported_for_channel_type": "This type of conversation cannot be used with this method.",
"not_enough_users": "Needs at least 2 users to open",
"too_many_users": "Needs at most 8 users to open",
"user_disabled": "A specified `user` has been disabled.",
"user_not_found": "Value(s) passed for `users` was invalid.",
"user_not_visible": "The calling user is restricted from seeing the requested user.",
"users_list_not_supplied": "Missing `users` in request"
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "channels:manage",
"url": "https://docs.slack.dev/reference/scopes/channels.manage"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
],
"user": [
{
"name": "channels:write",
"url": "https://docs.slack.dev/reference/scopes/channels.write"
},
{
"name": "groups:write",
"url": "https://docs.slack.dev/reference/scopes/groups.write"
},
{
"name": "im:write",
"url": "https://docs.slack.dev/reference/scopes/im.write"
},
{
"name": "mpim:write",
"url": "https://docs.slack.dev/reference/scopes/mpim.write"
}
]
}
}