users.getPresence

Gets user presence information.

This method lets you find out information about a user's presence. Consult the presence documentation for more details.

Arguments

token

Authentication token bearing required scopes.

Examplexxxx-xxxxxxxxx-xxxx
user

User to get presence info on. Defaults to the authed user.

ExampleW1234567890

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Response

When requesting information for a different user, this method just returns the current presence (either active or away).

{
    "ok": true,
    "presence": "active"
}

If you are requesting presence information for the authed user, this method returns the current presence, along with details on how it was calculated.

{
    "ok": true,
    "presence": "active",
    "online": true,
    "auto_away": false,
    "manual_away": false,
    "connection_count": 1,
    "last_activity": 1419027078
}

Typical error response

{
    "ok": false,
    "error": "invalid_auth"
}

presence indicates the user's overall presence, it will either be active or away.

online will be true if they have a client currently connected to Slack. auto_away will be true if our servers haven't detected any activity from the user in the last 30 minutes. manual_away will be true if the user has manually set their presence to away.

connection_count gives a count of total connections.

last_activity indicates the last activity seen by our servers. If a user has no connected clients then this property will be absent.

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.

ErrorDescription
forbidden

Access forbidden.

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.

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 _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

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 Retry-After header for when to retry the request.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

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.

WarningDescription
missing_charset

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.

superfluous_charset

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.

ArgumentValue
tokenRequiredNeed a token? Create and install a Slack app to begin.
userRequired
Extra args
  

Was this page helpful?