Slack. Web. Im
(SlackKit v1.0.0-alpha.0)
View Source
Summary
Functions
Close a direct message channel.
Fetches history of messages and events from direct message channel.
Lists direct message channels for the calling user.
Sets the read cursor in a direct message channel.
Opens a direct message channel.
Retrieve a thread of messages posted to a direct message conversation.
Functions
Close a direct message channel.
API reference
Required Params
channel- Direct message channel to close.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.user_does_not_own_channel- Calling user does not own this DM channel.
See the Common Errors guide for errors returned by every Web API method.
Fetches history of messages and events from direct message channel.
API reference
Required Params
channel- Direct message channel to fetch history for.
Optional Params
count- Number of messages to return, between 1 and 1000. ex:100inclusive- Include messages with latest or oldest timestamp in results. ex:1latest- End of time range of messages to include in results.oldest- Start of time range of messages to include in results.unreads- Includeunread_count_displayin the output? ex:1
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.invalid_ts_latest- Value passed forlatestwas invalidinvalid_ts_oldest- Value passed foroldestwas invalid
See the Common Errors guide for errors returned by every Web API method.
Lists direct message channels for the calling user.
API reference
See the Common Errors guide for errors returned by every Web API method.
Sets the read cursor in a direct message channel.
API reference
Required Params
channel- Direct message channel to set reading cursor in.ts- Timestamp of the most recently seen message.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.invalid_timestamp- Value passed fortimestampwas invalid.not_in_channel- Caller is not a member of the channel.
See the Common Errors guide for errors returned by every Web API method.
Opens a direct message channel.
API reference
Required Params
user- User to open a direct message channel with.
Errors the API can return:
user_disabled- Theuserhas been disabled.user_not_found- Value passed foruserwas invalid.user_not_visible- The calling user is restricted from seeing the requested user.
See the Common Errors guide for errors returned by every Web API method.
Retrieve a thread of messages posted to a direct message conversation.
API reference
Required Params
channel- Direct message channel to fetch thread fromthread_ts- Unique identifier of a thread's parent message.
Errors the API can return:
channel_not_found- Value passed forchannelwas invalid.thread_not_found- Value for thread_ts was missing or invalid.
See the Common Errors guide for errors returned by every Web API method.