SlackWeb.Team (SlackWeb v0.1.2) View Source

Link to this section Summary

Functions

Gets the access logs for the current team.

Gets billable users information for the current team.

Gets information about the current team.

Gets the integration logs for the current team.

Link to this section Functions

Link to this function

access_logs(optional_params \\ %{})

View Source

Gets the access logs for the current team.

Errors the API can return:

  • over_pagination_limit - It is not possible to request more than 1000 items per page or more than 100 pages.
  • paid_only - This is only available to paid teams.
Link to this function

billable_info(optional_params \\ %{})

View Source

Gets billable users information for the current team.

Optional Params

  • team_id - Encoded team id to get the billable information from, required if org token is used. ex: T1234567890
  • user - A user to retrieve the billable information for. Defaults to all users. ex: W1234567890

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.
  • 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 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_array_arg - The method was passed an array as an argument. Please only input valid strings.
  • 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.
  • 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_access_not_granted - The token used is not granted the specific workspace access required to complete this request.
  • 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_revoked - Authentication token is for a deleted user or workspace or the app has been removed.
  • two_factor_setup_required - Two factor setup is required.
  • user_not_found - Unable to find the requested user.
Link to this function

info(optional_params \\ %{})

View Source

Gets information about the current team.

Errors the API can return:

Link to this function

integration_logs(optional_params \\ %{})

View Source

Gets the integration logs for the current team.

Optional Params

  • app_id - Filter logs to this Slack app. Defaults to all logs.
  • change_type - Filter logs with this change type. Defaults to all logs. ex: added
  • service_id - Filter logs to this service. Defaults to all logs.
  • user - Filter logs generated by this user’s actions. Defaults to all logs.

Errors the API can return: