Skip to content

Commit 339aed4

Browse files
author
Slack API Ref Buildbot
committed
Updated from Slack docs, 2025/10/07
1 parent b1fefe9 commit 339aed4

File tree

7 files changed

+886
-0
lines changed

7 files changed

+886
-0
lines changed

‎docs.slack.dev/methods/chat.appendStream.json‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
{
2+
"desc": "Appends text to an existing streaming conversation.",
3+
"http_method": "POST",
4+
"scope": {
5+
"bot": [
6+
"chat:write"
7+
]
8+
},
9+
"rate_limits": "t4",
10+
"json_input_supported": true,
11+
"slack_connect_workspaces_allowed": true,
12+
"args": {
13+
"type": "object",
14+
"required": [
15+
"token",
16+
"channel",
17+
"ts",
18+
"markdown_text"
19+
],
20+
"properties": {
21+
"token": {
22+
"type": "string",
23+
"subtype": "auth",
24+
"org_app": {
25+
"allowed": true,
26+
"derive_team_context_from": "channel"
27+
},
28+
"example": "xxxx-xxxxxxxxx-xxxx"
29+
},
30+
"channel": {
31+
"desc": "An encoded ID that represents a channel, private group, or DM",
32+
"type": "string",
33+
"subtype": "channel"
34+
},
35+
"ts": {
36+
"desc": "The timestamp of the streaming message.",
37+
"schema": "ts"
38+
},
39+
"markdown_text": {
40+
"desc": "Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is what will be appended to the message received so far.",
41+
"type": "string",
42+
"example": "**This is bold text**"
43+
}
44+
}
45+
},
46+
"output": {
47+
"required": [
48+
"channel",
49+
"ts"
50+
],
51+
"properties": {
52+
"channel": {
53+
"schema": "channel"
54+
},
55+
"ts": {
56+
"schema": "ts"
57+
}
58+
},
59+
"type": "object"
60+
},
61+
"errors": {
62+
"message_not_in_streaming_state": {
63+
"desc": "The message is not in the streaming state."
64+
},
65+
"messaging_processing_failed": {
66+
"desc": "Failed to process the message."
67+
},
68+
"as_user_not_supported": {
69+
"desc": "The `as_user` parameter does not function with workspace apps."
70+
},
71+
"channel_not_found": {
72+
"desc": "Value passed for `channel` was invalid."
73+
},
74+
"duplicate_channel_not_found": {
75+
"desc": "Channel associated with `client_msg_id` was invalid."
76+
},
77+
"duplicate_message_not_found": {
78+
"desc": "No duplicate message exists associated with `client_msg_id`."
79+
},
80+
"ekm_access_denied": {
81+
"desc": "Your message couldn’t be sent because your admins have disabled sending messages to this channel."
82+
},
83+
"invalid_metadata_format": {
84+
"desc": "Invalid metadata format provided"
85+
},
86+
"invalid_metadata_schema": {
87+
"desc": "Invalid metadata schema provided"
88+
},
89+
"is_archived": {
90+
"desc": "Channel has been archived."
91+
},
92+
"message_limit_exceeded": {
93+
"desc": "Members on this team are sending too many messages. For more details, see https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces"
94+
},
95+
"messages_tab_disabled": {
96+
"desc": "Messages tab for the app is disabled."
97+
},
98+
"metadata_must_be_sent_from_app": {
99+
"desc": "Message metadata can only be posted or updated using an app-level token"
100+
},
101+
"metadata_too_large": {
102+
"desc": "Metadata exceeds size limit"
103+
},
104+
"no_text": {
105+
"desc": "No message text provided"
106+
},
107+
"not_in_channel": {
108+
"desc": "Cannot post user messages to a channel they are not in."
109+
},
110+
"rate_limited": {
111+
"desc": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information"
112+
},
113+
"restricted_action": {
114+
"desc": "A workspace preference prevents the authenticated user from posting."
115+
},
116+
"restricted_action_non_threadable_channel": {
117+
"desc": "Cannot post thread replies into a non_threadable channel."
118+
},
119+
"restricted_action_read_only_channel": {
120+
"desc": "Cannot post any message into a read-only channel."
121+
},
122+
"restricted_action_thread_locked": {
123+
"desc": "Cannot post replies to a thread that has been locked by admins."
124+
},
125+
"restricted_action_thread_only_channel": {
126+
"desc": "Cannot post top-level messages into a thread-only channel."
127+
},
128+
"slack_connect_canvas_sharing_blocked": {
129+
"desc": "Admin has disabled Canvas File sharing in all Slack Connect communications"
130+
},
131+
"slack_connect_file_link_sharing_blocked": {
132+
"desc": "Admin has disabled Slack File sharing in all Slack Connect communications"
133+
},
134+
"slack_connect_lists_sharing_blocked": {
135+
"desc": "Admin has disabled Lists sharing in all Slack Connect communications"
136+
},
137+
"team_not_found": {
138+
"desc": "This error occurs if, when using an org-wide token, the `channel_name` is passed instead of the `channel_id`."
139+
},
140+
"too_many_attachments": {
141+
"desc": "Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message."
142+
},
143+
"too_many_contact_cards": {
144+
"desc": "Too many contact_cards were provided with this message. A maximum of 10 contact cards are allowed on a message."
145+
},
146+
"message_not_found": {
147+
"desc": "Message not found"
148+
},
149+
"channel_type_not_supported": {
150+
"desc": "Channel type not supported"
151+
}
152+
},
153+
"examples": {
154+
"success": {
155+
"url": "/api/chat.appendStream?token=YOUR_TOKEN",
156+
"description": "Typical success response when appending to a streaming message",
157+
"example": {
158+
"ok": true,
159+
"channel": "C123ABC456",
160+
"ts": "1503435956.000247"
161+
}
162+
},
163+
"error": {
164+
"url": "/api/chat.appendStream?token=INVALID_TOKEN",
165+
"description": "Typical error response",
166+
"example": {
167+
"ok": false,
168+
"error": "invalid_auth"
169+
}
170+
}
171+
},
172+
"warnings": {
173+
"message_truncated": {
174+
"desc": "The `text` field of a message should have no more than 40,000 characters. We [truncate really long messages](/changelog/2018-04-truncating-really-long-messages)."
175+
}
176+
}
177+
}

‎docs.slack.dev/methods/chat.startStream.json‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
{
2+
"desc": "Starts a new streaming conversation.",
3+
"http_method": "POST",
4+
"scope": {
5+
"bot": [
6+
"chat:write"
7+
]
8+
},
9+
"rate_limits": "t2",
10+
"json_input_supported": true,
11+
"slack_connect_workspaces_allowed": true,
12+
"args": {
13+
"type": "object",
14+
"required": [
15+
"token",
16+
"channel",
17+
"thread_ts"
18+
],
19+
"properties": {
20+
"token": {
21+
"type": "string",
22+
"subtype": "auth",
23+
"org_app": {
24+
"allowed": true,
25+
"derive_team_context_from": "channel"
26+
},
27+
"example": "xxxx-xxxxxxxxx-xxxx"
28+
},
29+
"channel": {
30+
"desc": "An encoded ID that represents a channel, private group, or DM",
31+
"type": "string",
32+
"subtype": "channel"
33+
},
34+
"markdown_text": {
35+
"desc": "Accepts message text formatted in markdown. Limit this field to 12,000 characters.",
36+
"type": "string",
37+
"example": "**This is bold text**",
38+
"hidden": false
39+
},
40+
"thread_ts": {
41+
"desc": "Provide another message's `ts` value to reply to. Streamed messages should always be replies to a user request.",
42+
"type": "string",
43+
"example": "1721609600"
44+
},
45+
"recipient_user_id": {
46+
"desc": "The encoded ID of the user to receive the streaming text. Required when streaming to channels.",
47+
"schema": "user_id"
48+
},
49+
"recipient_team_id": {
50+
"desc": "The encoded ID of the team the user receiving the streaming text belongs to. Required when streaming to channels.",
51+
"type": "string",
52+
"example": "T0123456789"
53+
}
54+
}
55+
},
56+
"output": {
57+
"required": [
58+
"channel",
59+
"ts"
60+
],
61+
"properties": {
62+
"channel": {
63+
"schema": "channel"
64+
},
65+
"ts": {
66+
"desc": "The timestamp of the streaming message.",
67+
"schema": "ts"
68+
}
69+
},
70+
"type": "object"
71+
},
72+
"errors": {
73+
"messaging_processing_failed": {
74+
"desc": "Failed to process the message."
75+
},
76+
"channel_not_found": {
77+
"desc": "Value passed for `channel` was invalid."
78+
},
79+
"duplicate_channel_not_found": {
80+
"desc": "Channel associated with `client_msg_id` was invalid."
81+
},
82+
"duplicate_message_not_found": {
83+
"desc": "No duplicate message exists associated with `client_msg_id`."
84+
},
85+
"ekm_access_denied": {
86+
"desc": "Your message couldn’t be sent because your admins have disabled sending messages to this channel."
87+
},
88+
"invalid_blocks": {
89+
"desc": "Blocks submitted with this message are not valid"
90+
},
91+
"invalid_blocks_format": {
92+
"desc": "The `blocks` is not a valid JSON object or doesn't match the Block Kit syntax."
93+
},
94+
"invalid_metadata_format": {
95+
"desc": "Invalid metadata format provided"
96+
},
97+
"invalid_metadata_schema": {
98+
"desc": "Invalid metadata schema provided"
99+
},
100+
"is_archived": {
101+
"desc": "Channel has been archived."
102+
},
103+
"message_limit_exceeded": {
104+
"desc": "Members on this team are sending too many messages. For more details, see https://slack.com/help/articles/115002422943-Usage-limits-for-free-workspaces"
105+
},
106+
"messages_tab_disabled": {
107+
"desc": "Messages tab for the app is disabled."
108+
},
109+
"metadata_must_be_sent_from_app": {
110+
"desc": "Message metadata can only be posted or updated using an app-level token"
111+
},
112+
"metadata_too_large": {
113+
"desc": "Metadata exceeds size limit"
114+
},
115+
"msg_blocks_too_long": {
116+
"desc": "Blocks submitted with this message are too long."
117+
},
118+
"no_text": {
119+
"desc": "No message text provided"
120+
},
121+
"not_in_channel": {
122+
"desc": "Cannot post user messages to a channel they are not in."
123+
},
124+
"rate_limited": {
125+
"desc": "Application has posted too many messages, [read the Rate Limit documentation](/docs/rate-limits) for more information"
126+
},
127+
"restricted_action": {
128+
"desc": "A workspace preference prevents the authenticated user from posting."
129+
},
130+
"restricted_action_non_threadable_channel": {
131+
"desc": "Cannot post thread replies into a non_threadable channel."
132+
},
133+
"restricted_action_read_only_channel": {
134+
"desc": "Cannot post any message into a read-only channel."
135+
},
136+
"restricted_action_thread_locked": {
137+
"desc": "Cannot post replies to a thread that has been locked by admins."
138+
},
139+
"restricted_action_thread_only_channel": {
140+
"desc": "Cannot post top-level messages into a thread-only channel."
141+
},
142+
"slack_connect_canvas_sharing_blocked": {
143+
"desc": "Admin has disabled Canvas File sharing in all Slack Connect communications"
144+
},
145+
"slack_connect_file_link_sharing_blocked": {
146+
"desc": "Admin has disabled Slack File sharing in all Slack Connect communications"
147+
},
148+
"slack_connect_lists_sharing_blocked": {
149+
"desc": "Admin has disabled Lists sharing in all Slack Connect communications"
150+
},
151+
"team_not_found": {
152+
"desc": "This error occurs if, when using an org-wide token, the `channel_name` is passed instead of the `channel_id`."
153+
},
154+
"channel_type_not_supported": {
155+
"desc": "Channel type not supported"
156+
},
157+
"user_not_found": {
158+
"desc": "User not found."
159+
},
160+
"missing_recipient_team_id": {
161+
"desc": "Missing recipient team ID."
162+
},
163+
"missing_recipient_user_id": {
164+
"desc": "Missing recipient user ID."
165+
}
166+
},
167+
"examples": {
168+
"success": {
169+
"url": "/api/chat.startStream?token=YOUR_TOKEN",
170+
"description": "Typical success response when starting a streaming message",
171+
"example": {
172+
"ok": true,
173+
"channel": "C123ABC456",
174+
"ts": "1503435956.000247"
175+
}
176+
},
177+
"error": {
178+
"url": "/api/chat.startStream?token=INVALID_TOKEN",
179+
"description": "Typical error response",
180+
"example": {
181+
"ok": false,
182+
"error": "invalid_auth"
183+
}
184+
}
185+
},
186+
"warnings": {
187+
"message_truncated": {
188+
"desc": "The `text` field of a message should have no more than 40,000 characters. We [truncate really long messages](/changelog/2018-04-truncating-really-long-messages)."
189+
}
190+
}
191+
}

0 commit comments

Comments
 (0)