SlackWeb.Users (SlackWeb v0.1.3) View Source

Link to this section Summary

Functions

Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.

Gets user presence information.

Gets information about a user.

Lists all users in a Slack team.

Retrieve a single user by looking them up by their registered email address. Requires users:read.email.

Marks a user as active.

Manually sets user presence.

Link to this section Functions

Link to this function

conversations(optional_params \\ %{})

View Source

Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.

Optional Params

  • cursor - Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first "page" of the collection. See pagination for more detail. ex: dXNlcjpVMDYxTkZUVDI=
  • exclude_archived - Set this to true to exclude archived channels from the list ex: true
  • limit - The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000. ex: 20
  • types - Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im ex: public_channel,private_channel
  • user - Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. ex: W0B2345D

Errors the API can return:

  • method_not_supported_for_channel_type - This type of conversation cannot be used with this method.
Link to this function

get_presence(user, optional_params \\ %{})

View Source

Gets user presence information.

Required Params

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

Errors the API can return:

Link to this function

identity(token, optional_params \\ %{})

View Source

Get a user's identity.

Required Params

  • token - Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Errors the API can return:

  • accesslimited - Access to this method is limited on the current network
  • account_inactive - Authentication token is for a deleted user or workspace when using a bot token.
  • deprecated_endpoint - The endpoint has been deprecated.
  • ekm_access_denied - Administrators have suspended the ability to post a message.
  • enterprise_is_restricted - The method cannot be called from an Enterprise.
  • 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.
  • 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_arguments - The method was called with invalid arguments.
  • 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.
  • 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.
  • invalid_user_id - Invalid user id provided
  • is_bot - This method cannot be called by a bot user.
  • method_deprecated - The method has been deprecated.
  • 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.
  • missing_scope - The token used is not granted the specific scope permissions required to complete this request.
  • 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.
  • not_allowed_token_type - The token type used in this request is not allowed.
  • not_authed - No authentication token provided.
  • org_login_required - The workspace is undergoing an enterprise migration and will not be available until migration 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
  • 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.
  • token_expired - Authentication token has expired
  • token_revoked - Authentication token is for a deleted user or workspace or the app has been removed when using a user token.
  • two_factor_setup_required - Two factor setup is required.
Link to this function

info(user, optional_params \\ %{})

View Source

Gets information about a user.

Required Params

  • user - User to get info on

Errors the API can return:

  • user_not_found - Value passed for user was invalid.
  • user_not_visible - The requested user is not visible to the calling user
Link to this function

list(optional_params \\ %{})

View Source

Lists all users in a Slack team.

Optional Params

  • presence - Whether to include presence data in the output ex: 1
Link to this function

lookup_by_email(email, optional_params \\ %{})

View Source

Retrieve a single user by looking them up by their registered email address. Requires users:read.email.

Required Params

  • email - User's email address

Errors the API can return:

  • missing_scope - The token used is not granted the specific scope permissions required to complete this request. Need: users:read.email.
  • user_not_found - Value passed for user was invalid.
Link to this function

set_active(optional_params \\ %{})

View Source

Marks a user as active.

Errors the API can return:

Link to this function

set_presence(presence, optional_params \\ %{})

View Source

Manually sets user presence.

Required Params

  • presence - Either auto or away ex: away

Errors the API can return:

  • invalid_presence - Value passed for presence was invalid.