Current section
Files
Jump to
Current section
Files
priv/docs/methods/conversations.history.json
{
"args": {
"channel": {
"desc": "Conversation ID to fetch history for.",
"required": true,
"type": "string"
},
"cursor": {
"desc": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See pagination for more detail.",
"example": "dXNlcjpVMDYxTkZUVDI=",
"required": false,
"type": "string"
},
"include_all_metadata": {
"desc": "Return all metadata associated with this message. 0",
"example": "true",
"required": false,
"type": "boolean"
},
"inclusive": {
"desc": "Include messages with `oldest` or `latest` timestamps in results. Ignored unless either timestamp is specified. 0",
"example": "true",
"required": false,
"type": "boolean"
},
"latest": {
"desc": "Only messages before this Unix timestamp will be included in results. Default is the current time. Call the method with no `oldest` or `latest` arguments to read the entire history for a conversation.",
"required": false,
"type": "string"
},
"limit": {
"default": "100",
"desc": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the conversation history hasn't been reached. Maximum of 999.",
"example": "20",
"required": false,
"type": "number"
},
"oldest": {
"default": "0",
"desc": "Only messages after this Unix timestamp will be included in results. Call the method with no `oldest` or `latest` arguments to read the entire history for a conversation.",
"required": false,
"type": "string"
}
},
"desc": "Fetches a conversation's history of messages and events.",
"errors": {
"channel_is_limited_access": "The user has no access to the channel. This is only applicable to private Salesforce record channels.",
"channel_not_found": "Value passed for `channel` was invalid.",
"invalid_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"invalid_metadata_filter_keys": "Value passed for `metadata_keys_to_include` was invalid. Must be valid json array of strings.",
"invalid_ts_latest": "Value passed for `latest` was invalid",
"invalid_ts_oldest": "Value passed for `oldest` was invalid",
"not_in_channel": "The token used does not have access to the proper channel. Only user tokens can access public channels they are not in."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "channels:history",
"url": "https://docs.slack.dev/reference/scopes/channels.history"
},
{
"name": "groups:history",
"url": "https://docs.slack.dev/reference/scopes/groups.history"
},
{
"name": "im:history",
"url": "https://docs.slack.dev/reference/scopes/im.history"
},
{
"name": "mpim:history",
"url": "https://docs.slack.dev/reference/scopes/mpim.history"
}
],
"user": [
{
"name": "channels:history",
"url": "https://docs.slack.dev/reference/scopes/channels.history"
},
{
"name": "groups:history",
"url": "https://docs.slack.dev/reference/scopes/groups.history"
},
{
"name": "im:history",
"url": "https://docs.slack.dev/reference/scopes/im.history"
},
{
"name": "mpim:history",
"url": "https://docs.slack.dev/reference/scopes/mpim.history"
}
]
}
}