Skip to main content

@slack/web-api / AgentsSessionsSetStatusArguments

Interface: AgentsSessionsSetStatusArguments

Defined in: packages/web-api/src/types/request/agents.ts:17

Extends​

  • TokenOverridable

Properties​

channel_id​

channel_id: string;

Defined in: packages/web-api/src/types/request/agents.ts:19

Description​

ID of the channel containing the agent session.

icon_emoji?​

optional icon_emoji?: string;

Defined in: packages/web-api/src/types/request/agents.ts:42

Description​

Emoji to use as the agent's icon. Takes priority over icon_url. Remains in effect until you clear it (pass null) or set a new value. Requires the chat:write.customize scope.

Example​

:chart_with_upwards_trend:

icon_url?​

optional icon_url?: string;

Defined in: packages/web-api/src/types/request/agents.ts:48

Description​

URL to an image to use as the agent's icon. Remains in effect until you clear it (pass null) or set a new value. Requires the chat:write.customize scope.

Example​

http://lorempixel.com/48/48

initiator_user_id?​

optional initiator_user_id?: string;

Defined in: packages/web-api/src/types/request/agents.ts:36

Description​

The user who initiated the session. Only used when creating a new session; ignored if the session already exists. Must be a member of the channel.

status​

status: string;

Defined in: packages/web-api/src/types/request/agents.ts:21

Description​

The lifecycle status to set. Acceptable values: active, processing, suspended, closed.

thread_ts?​

optional thread_ts?: string;

Defined in: packages/web-api/src/types/request/agents.ts:26

Description​

Timestamp of the thread root message the session is scoped to. Required for thread-based sessions in regular channels and DMs. Must be omitted for session channels.

title?​

optional title?: string;

Defined in: packages/web-api/src/types/request/agents.ts:31

Description​

Title for the agent session (max 200 characters). Only used when creating a new session; ignored if the session already exists. To rename an existing session, use agents.sessions.rename.

token?​

optional token?: string;

Defined in: packages/web-api/src/types/request/common.ts:43

Description​

Overridable authentication token bearing required scopes.

Inherited from​

TokenOverridable.token

username?​

optional username?: string;

Defined in: packages/web-api/src/types/request/agents.ts:54

Description​

Display name override for the agent (max 200 characters). Remains in effect until you clear it (pass null) or set a new value. Requires the chat:write.customize scope.

Example​

My Bot