Gets a URL for an edge external file upload
GEThttps://slack.com/api/files.getUploadURLExternal
application/x-www-form-urlencoded
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
xxxx-xxxxxxxxx-xxxx
This method gets a URL that can be used for uploading a file to share within channels. The URL allows clients to send file data to Slack's file upload service.
The workflow is as follows:
files.getUploadURLExternal
, which returns an upload URL and a file ID.-F filename="@text.txt"
). Files are processed asynchronously via a job handler.
files.completeUploadExternal
to finalize the upload.
files.completeUploadExternal
method will return with no action until both processes have completed. If files.completeUploadExternal
is not called, the upload will be aborted and clients will recieve an error.If you have migrated to the v2 method, note that this method requires both files:write
and files:read
scopes. If your existing apps have only the files:write
scope for uploading files, you must add files:read
, then re-install the app to issue an updated token. Refer to files.upload v2 in WebClient/AsyncWebClient for more information.
Typical success response
{
"ok": true,
"upload_url": "https://files.slack.com/upload/v1/ABC123...",
"file_id": "F123ABC456"
}
Typical error response
{
"ok": false,
"error": "invalid_auth"
}
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 |
---|---|
alt_txt_too_large | Description for the image is longer than the limit of 1000 character |
file_upload_size_restricted | The size of provided file is too large, as the team has restricted uploads of large files. |
file_uploads_disabled | Team has disabled all file uploads. |
missing_argument | A required argument was not provided. Typically only occurs when the |
snippet_too_large | The provided |
storage_limit_reached | File storage limit has been reached. This occurs when free teams have uploaded 5GB of files. |
unknown_snippet_type | The provided |
unknown_subtype | The provided |
access_denied | Access to a resource specified in the request is denied. |
account_inactive | Authentication token is for a deleted user or workspace when using a |
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. |
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. |
method_deprecated | The method has been deprecated. |
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. |
not_authed | No authentication token provided. |
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. |
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 |
two_factor_setup_required | Two factor setup is required. |
accesslimited | Access to this method is limited on the current network |
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 |
invalid_arguments | The method was either called with invalid arguments or some detail about the arguments passed is 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_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 |
ratelimited | The request has been ratelimited. Refer to the |
request_timeout | The method was called via a |
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. |
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 |