Skip to main content

@slack/web-api / ChatStartStreamArguments

Interface: ChatStartStreamArguments

Defined in: src/types/request/chat.ts:221

Extends​

  • TokenOverridable.Channel.Partial<MarkdownText>.ThreadTS

Properties​

channel​

channel: string;

Defined in: src/types/request/chat.ts:20

Description​

Channel ID for the message.

Inherited from​

Channel.channel

markdown_text?​

optional markdown_text: string;

Defined in: src/types/request/chat.ts:61

Description​

Accepts message text formatted in markdown. This argument should not be used in conjunction with blocks or text. Limit this field to 12,000 characters.

Example​

**This is bold text**

Inherited from​

ChatAppendStreamArguments.markdown_text

recipient_team_id?​

optional recipient_team_id: string;

Defined in: src/types/request/chat.ts:226

Description​

The ID of the team that is associated with recipient_user_id. This is required when starting a streaming conversation outside of a DM.

recipient_user_id?​

optional recipient_user_id: string;

Defined in: src/types/request/chat.ts:231

Description​

The ID of the user to receive the streaming conversation messages. This is required when starting a streaming conversation outside of a DM.

thread_ts​

thread_ts: string;

Defined in: src/types/request/chat.ts:90

Description​

Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead.

Inherited from​

ThreadTS.thread_ts

token?​

optional token: string;

Defined in: src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token