Gets information about a bot user.
Method URL: | https://slack.com/api/bots.info |
||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | GET |
||||||||
Accepted content types: | application/x-www-form-urlencoded |
||||||||
Rate limiting: | Tier 3 | ||||||||
Works with: |
|
This method returns extended information about a bot user.
Per workspace, bot users have both a user ID (which can be looked up using users.info
) and a "bot ID."
bot_id
fields appear in bot_message
message event subtypes and in the response of methods like conversations.history
.
Use this method to look up the username and icons for those bot users. Use the app_id
field to identify whether a bot belongs to your Slack app.
Look for a user_id
When the bot corresponds directly to a bot user account. Some bot-like entities aren't actually "bot users" and will not include a user_id
.
Argument | Example | Required | Description |
---|---|---|---|
token | xxxx-xxxxxxxxx-xxxx |
Required | Authentication token bearing required scopes. |
bot | B12345678 |
Optional | Bot user to get info on |
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
When successful, returns bot info by bot ID.
{
"ok": true,
"bot": {
"id": "B061F7JQ1",
"deleted": false,
"name": "commandeer",
"updated": 1449272004,
"app_id": "A061BLERW",
"icons": {
"image_36": "https:\/\/...",
"image_48": "https:\/\/...",
"image_72": "https:\/\/..."
}
}
}
When successful, returns bot info by bot ID.
{
"ok": true,
"bot": {
"id": "B061F7JD2",
"deleted": false,
"name": "beforebot",
"updated": 1449272004,
"app_id": "A161CLERW",
"user_id": "U012ABCDEF",
"icons": {
"image_36": "https:\/\/...",
"image_48": "https:\/\/...",
"image_72": "https:\/\/..."
}
}
}
When no bot can be found, it returns an error.
{
"ok": false,
"error": "bot_not_found"
}
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.
Error | Description |
---|---|
bot_not_found |
Value passed for |
not_authed |
No authentication token provided. |
invalid_auth |
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. |
account_inactive |
Authentication token is for a deleted user or workspace. |
token_revoked |
Authentication token is for a deleted user or workspace or the app has been removed. |
no_permission |
The workspace token used in this request does not have the permissions necessary to complete the request. |
org_login_required |
The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
invalid_arg_name |
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 |
invalid_array_arg |
The method was passed a PHP-style array argument (e.g. with a name like |
invalid_charset |
The method was called via a |
invalid_form_data |
The method was called via a |
invalid_post_type |
The method was called via a |
missing_post_type |
The method was called via a |
team_added_to_org |
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. |
request_timeout |
The method was called via a |
fatal_error |
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.
Warning | Description |
---|---|
missing_charset | The method was called via a |
superfluous_charset | The method was called via a |