bots.info
Gets information about a bot user.
Facts
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
.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
bot
Bot user to get info on
ExampleB12345678
team_id
encoded team id or enterprise id where the bot exists, required if org token is used
ExampleT1234567890
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
Response
Common successful response
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://..."
}
}
}
Common error response
When no bot can be found, it returns an error.
{
"ok": false,
"error": "bot_not_found"
}
Errors
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 |
bots_not_found | At least one value passed for |
missing_argument | A required argument is missing. |
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. Make sure your app is a member of the conversation it's attempting to post a message to. |
org_login_required | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
ekm_access_denied | Administrators have suspended the ability to post a message. |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
deprecated_endpoint | The endpoint has been deprecated. |
two_factor_setup_required | Two factor setup is required. |
enterprise_is_restricted | The method cannot be called from an Enterprise. |
team_access_not_granted | The token used is not granted the specific workspace access required to complete this request. |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments. |
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 an array as an argument. Please only input valid strings. |
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. |
ratelimited | The request has been ratelimited. Refer to the |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
service_unavailable | The service is temporarily unavailable |
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. |
internal_error | The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised. |
Warnings
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 |