im.history

This method is deprecated.

Documentation Tester

Fetches history of messages and events from direct message channel.

Facts

Method URL: https://slack.com/api/im.history

Preferred HTTP method: GET

Accepted content types: application/x-www-form-urlencoded

Rate limiting: Tier 4

Works with:

Token type	Required scope(s)
bot	`im:history`
user	`im:history`
classic bot	`bot`

This method is deprecated. It will stop functioning in February 2021 and will not work with newly created apps after June 10th, 2020. Learn more.

Please use these methods instead:

conversations.history

This method returns a portion of messages/events from the specified direct message channel. To read the entire history for a direct message channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.

Arguments

tokenRequired

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Examplexxxx-xxxxxxxxx-xxxx

channelRequired

Direct message channel to fetch history for.

ExampleD1234567890

countOptional

Number of messages to return, between 1 and 1000.

Default: 100

Example100

inclusiveOptional

Include messages with latest or oldest timestamp in results.

Default: 0

Exampletrue

latestOptional

End of time range of messages to include in results.

Default: now

Example1234567890.123456

oldestOptional

Start of time range of messages to include in results.

Default: 0

Example1234567890.123456

unreadsOptional

Include unread_count_display in the output?

Default: 0

Exampletrue

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

Response

Common successful response

Typical success response

{
    "ok": true,
    "latest": "1358547726.000003",
    "messages": [
        {
            "type": "message",
            "ts": "1358546515.000008",
            "user": "U2147483896",
            "text": "Hello"
        },
        {
            "type": "message",
            "ts": "1358546515.000007",
            "user": "U2147483896",
            "text": "World",
            "is_starred": true
        },
        {
            "type": "something_else",
            "ts": "1358546515.000007"
        }
    ],
    "has_more": false
}

Common error response

Typical error response

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

The messages array 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.

If a message has the same timestamp as latest or oldest it will not be included in the list, unless inclusive is true. This allows a client to fetch all messages in a hole in channel history, by calling channels.history with latest set to the oldest message they have after the hole, and oldest to the latest message they have before the hole. 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.

Messages of type "message" are user-entered text messages sent to the direct message channel, while other types are events that happened within the direct message 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.

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.

Error	Description
`channel_not_found`	Value passed for `channel` was invalid.
`invalid_ts_latest`	Value passed for `latest` was invalid
`invalid_ts_oldest`	Value passed for `oldest` was invalid
`not_authed`	No authentication token provided.
`invalid_auth`	Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
`account_inactive`	Authentication token is for a deleted user or workspace.
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed.
`no_permission`	The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`method_deprecated`	The method called is retired and no longer accepts requests. Examine the error closely for suggestions on alternative methods to use or browse api.slack.com/changelog for more information.
`deprecated_endpoint`	The endpoint has been deprecated.
`two_factor_setup_required`	Two factor setup is required.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`invalid_arguments`	The method was either called with invalid arguments or some detail about the arguments passed are invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_arg_name`	The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a very malformed API call.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.
`invalid_form_data`	The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.
`invalid_post_type`	The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`team_added_to_org`	The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`accesslimited`	Access to this method is limited on the current network
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`fatal_error`	The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
`internal_error`	The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.

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.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.
`method_deprecated`	The method called has been deprecated and may soon stop functioning. Examine the warning closely for suggestions on alternative methods to use or browse api.slack.com/changelog for more information.

Was this page helpful?