conversations.history

Fetches a conversation's history of messages and events.

Facts

This Conversations API method's required scopes depend on the type of channel-like object you're working with. To use the method, you'll need at least one of the channels:, groups:, im: or mpim: scopes corresponding to the conversation type you're working with.

This method returns a portion of message events from the specified conversation.

To read the entire history for a conversation, call the method with no latest or oldest arguments, and then continue paging using the instructions below.

The scopes and token types required to use this method vary by conversation type:

• Apps using classic bot user token may use this method for direct message and multi-party direct message conversations but lack sufficient permissions to use this method on public and private channels.
• Every other type of token can be used with this method for any conversations the relevant app, bot, or user is a member of. The calling app must also have the relevant *:history scope for the conversation type.

Arguments

Present arguments as parameters in application/x-www-form-urlencoded querystring or POST body. This method does not currently accept application/json.

Response

{
    "ok": true,
    "messages": [
        {
            "type": "message",
            "user": "U012AB3CDE",
            "text": "I find you punny and would like to smell your nose letter",
            "ts": "1512085950.000216"
        },
        {
            "type": "message",
            "user": "U061F7AUR",
            "text": "What, you want to smell my shoes better?",
            "ts": "1512104434.000490"
        }
    ],
    "has_more": true,
    "pin_count": 0,
    "response_metadata": {
        "next_cursor": "bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz"
    }
}

{
    "ok": true,
    "messages": [
        {
            "type": "message",
            "user": "U012AB3CDE",
            "text": "I find you punny and would like to smell your nose letter",
            "ts": "1512085950.000216"
        },
        {
            "type": "message",
            "user": "U061F7AUR",
            "text": "Isn't this whether dreadful? <https://badpuns.example.com/puns/123>",
            "attachments": [
                {
                    "service_name": "Leg end nary a laugh, Ink.",
                    "text": "This is likely a pun about the weather.",
                    "fallback": "We're withholding a pun from you",
                    "thumb_url": "https://badpuns.example.com/puns/123.png",
                    "thumb_width": 1920,
                    "thumb_height": 700,
                    "id": 1
                }
            ],
            "ts": "1512085950.218404"
        }
    ],
    "has_more": true,
    "pin_count": 0,
    "response_metadata": {
        "next_cursor": "bmV4dF90czoxNTEyMTU0NDA5MDAwMjU2"
    }
}

{
    "ok": true,
    "latest": "1512085950.000216",
    "messages": [
        {
            "type": "message",
            "user": "U012AB3CDE",
            "text": "I find you punny and would like to smell your nose letter",
            "ts": "1512085950.000216"
        }
    ],
    "has_more": true,
    "pin_count": 0,
    "response_metadata": {
        "next_cursor": "bmV4dF90czoxNTEyMzU2NTI2MDAwMTMw"
    }
}

{
    "ok": false,
    "error": "channel_not_found"
}

Pagination

Pagination by time

This form of pagination can be used in conjunction with cursors.

The messages array contains up to 100 messages between latest and oldest. If there were more than 100 messages between those two points, then has_more will be true.

Provide timestamps in latest and oldest to specify the period in channel's history you want to cover. If a message has the same timestamp as latest or oldest it will not be included in the list, unless inclusive is true. The inclusive parameter is ignored when latest or oldest is not specified.

If the response includes has_more then the client can make another call, using the ts value of the final messages as the latest param to get the next page of messages.

If there are more than 100 messages between the two timestamps then the messages returned are the ones closest to latest. In most cases an application will want the most recent messages and will page backward from there. If oldest is provided but not latest then the messages returned are those closest to oldest, allowing you to page forward through history if desired.

Retrieving a single message

conversations.history can also be used to pluck a single message from the archive.

You'll need a message's ts value, uniquely identifying it within a conversation. You'll also need that conversation's ID.

Provide another message's ts value as the latest parameter. Set limit to 1. If it exists, you'll receive the queried message in return.

Finally, use inclusive=true because otherwise we'll never retrieve the message we're actually after, just the ones that come after it.

GET /api/conversations.history?channel=C2EB2QT8A&latest=1476909142.000007&inclusive=true&limit=1
Authorization: Bearer TOKEN_WITH_CHANNELS_HISTORY_SCOPE

You can easily generate a permalink URL for any specific message using chat.getPermalink.

Message types

Messages of type "message" are user-entered text messages sent to the channel, while other types are events that happened within the channel. All messages have both a type and a sortable ts, but the other fields depend on the type. For a list of all possible events, see the channel messages documentation.

Messages that have been reacted to by team members will have a reactions array delightfully included.

If a message has been starred by the calling user, the is_starred property will be present and true. This property is only added for starred items, so is not present in the majority of messages.

The is_limited boolean property is only included for free teams that have reached the free message limit. If true, there are messages before the current result set, but they are beyond the message limit.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.