files.remote.share
Share a remote file into a channel.
Facts
Method URL: | https://slack.com/api/files.remote.share | ||||||||
---|---|---|---|---|---|---|---|---|---|
Preferred HTTP method: | GET | ||||||||
Accepted content types: | application/x-www-form-urlencoded | ||||||||
Rate limiting: | Tier 2 | ||||||||
Works with: |
|
A new file commenting experience arrived on July 23, 2018. Learn more about what's new and the migration path for apps already working with files and file comments.
This method shares a remote file into a Slack conversation. If you add a remote file without sharing the file, it remains an orphan inside Slack—you can view information on it via files.remote.info
method, but it won't actually be visible anywhere.
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
channels
Comma-separated list of channel IDs where the file will be shared.
ExampleC1234567890,C2345678901,C3456789012
external_id
The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or file
or both are required.
123456
file
Specify a file registered with Slack by providing its ID. Either this field or external_id
or both are required.
F2147483862
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
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 |
---|---|
not_in_channel | Authenticated user is not in at least one of the the provided channels. |
file_not_found | No file with the requested ID found. |
channel_not_found | At least one of the values passed for |
invalid_args | Invalid arguments passed to endpoint |
no_bot_user_for_app | Cannot call the Remote Files endpoints unless app has associated bot user |
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 |