This method is public, but this page is not. View the public page for this method.

chat.stopStream

View other methods

Stops a streaming conversation.

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/chat.stopStream

Bolt for Java

app.client().chatStopStream

Bolt for Python

app.client.chat_stopStream

Bolt for JavaScript

app.client.chat.stopStream

Required scopes

Bot tokenschat:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

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

Example

xxxx-xxxxxxxxx-xxxx

channel

string

·Required

An encoded ID that represents a channel, private group, or DM

Example

C1234567890

ts

·Required

The timestamp of the streaming message.

Optional arguments

blocks

blocks[] as string

·Optional

A list of blocks that will be rendered at the bottom of the finalized message.

markdown_text

string

·Optional

Accepts message text formatted in markdown. Limit this field to 12,000 characters.

Example

**This is bold text**

metadata

string

·Optional

JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

Example

{"event_type": "task_created", "event_payload": { "id": "11223", "title": "Redesign Homepage"}}

Usage info

There is no documentation for this method.

Sorry! There aren't any sample responses for this endpoint right now.

Example responses

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
`message_not_found`	The message was not found.
`message_not_in_streaming_state`	The message is not in a streaming state.
`as_user_not_supported`	The `as_user` parameter does not function with workspace apps.
`channel_not_found`	Value passed for `channel` was invalid.
`duplicate_channel_not_found`	Channel associated with `client_msg_id` was invalid.
`duplicate_message_not_found`	No duplicate message exists associated with `client_msg_id`.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`invalid_metadata_format`	Invalid metadata format provided
`invalid_metadata_schema`	Invalid metadata schema provided
`is_archived`	Channel has been archived.
`message_limit_exceeded`	Members on this team are sending too many messages. For more details, see https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces
`messages_tab_disabled`	Messages tab for the app is disabled.
`metadata_must_be_sent_from_app`	Message metadata can only be posted or updated using an app-level token
`metadata_too_large`	Metadata exceeds size limit
`no_text`	No message text provided
`not_in_channel`	Cannot post user messages to a channel they are not in.
`rate_limited`	Application has posted too many messages, read the Rate Limit documentation for more information
`restricted_action`	A workspace preference prevents the authenticated user from posting.
`restricted_action_non_threadable_channel`	Cannot post thread replies into a non_threadable channel.
`restricted_action_read_only_channel`	Cannot post any message into a read-only channel.
`restricted_action_thread_locked`	Cannot post replies to a thread that has been locked by admins.
`restricted_action_thread_only_channel`	Cannot post top-level messages into a thread-only channel.
`slack_connect_canvas_sharing_blocked`	Admin has disabled Canvas File sharing in all Slack Connect communications
`slack_connect_file_link_sharing_blocked`	Admin has disabled Slack File sharing in all Slack Connect communications
`slack_connect_lists_sharing_blocked`	Admin has disabled Lists sharing in all Slack Connect communications
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`team_not_found`	This error occurs if, when using an org-wide token, the `channel_name` is passed instead of the `channel_id`.
`too_many_attachments`	Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.
`too_many_contact_cards`	Too many contact_cards were provided with this message. A maximum of 10 contact cards are allowed on a message.
`cannot_reply_to_message`	This message type cannot have thread replies.
`missing_file_data`	Attempted to share a file but some required data was missing.
`attachment_payload_limit_exceeded`	Attachment payload size is too long.
`channel_type_not_supported`	Channel type not supported.
`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 `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`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.
`is_bot`	This method cannot be called by a legacy bot.
`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 `user` token.
`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 `_`. 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 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 `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.
`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.

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
`message_truncated`	The `text` field of a message should have no more than 40,000 characters. We truncate really long messages.
`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.

API response

URL

POST body

Submit your arguments to see the API response