conversations.replies
Retrieve a thread of messages posted to a conversation
channels:
, groups:
, im:
or mpim:
scopes corresponding to the conversation type you're working with.
This Conversations API method returns an entire thread (a message plus all the messages in reply to it), while conversations.history
method returns only parent messages.
The scopes and token types required to use this method vary by conversation type.
Bot user tokens 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.
To use conversations.replies
with public or private channel threads, use a user token with channels:history
or groups:history
scopes.
Arguments
token
Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
Examplexxxx-xxxxxxxxx-xxxx
channel
Conversation ID to fetch thread from.
ExampleC1234567890
ts
Unique identifier of a thread's parent message. ts
must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts
will return - it is just an ordinary, unthreaded message.
1234567890.123456
cursor
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.
dXNlcjpVMDYxTkZUVDI=
inclusive
Include messages with latest or oldest timestamp in results only when either timestamp is specified.
Default: 0
true
latest
End of time range of messages to include in results.
Default: now
1234567890.123456
limit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
Default: 10
20
oldest
Start of time range of messages to include in results.
Default: 0
1234567890.123456
application/x-www-form-urlencoded
querystring or POST body. This method does not currently accept application/json
.
The channel
and ts
arguments are always required. ts
must be
the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by ts
will return - it is just an ordinary message.
Response
Common successful response
Typical success response
{
"messages": [
{
"type": "message",
"user": "U061F7AUR",
"text": "island",
"thread_ts": "1482960137.003543",
"reply_count": 3,
"subscribed": true,
"last_read": "1484678597.521003",
"unread_count": 0,
"ts": "1482960137.003543"
},
{
"type": "message",
"user": "U061F7AUR",
"text": "one island",
"thread_ts": "1482960137.003543",
"parent_user_id": "U061F7AUR",
"ts": "1483037603.017503"
},
{
"type": "message",
"user": "U061F7AUR",
"text": "two island",
"thread_ts": "1482960137.003543",
"parent_user_id": "U061F7AUR",
"ts": "1483051909.018632"
},
{
"type": "message",
"user": "U061F7AUR",
"text": "three for the land",
"thread_ts": "1482960137.003543",
"parent_user_id": "U061F7AUR",
"ts": "1483125339.020269"
}
],
"has_more": true,
"ok": true,
"response_metadata": {
"next_cursor": "bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx"
}
}
Common error response
Typical error response
{
"ok": false,
"error": "thread_not_found"
}
Pagination
This method uses cursor-based pagination to make it easier to incrementally collect information. To begin pagination, specify alimit
value under 1000
. We recommend no more than 200
results at a time.Responses will include a top-level
response_metadata
attribute containing a next_cursor
value. By using this value as a cursor
parameter in a subsequent request, along with limit
, you may navigate through the collection page by virtual page.See pagination for more information.
Pagination by time
You can also get messages of certain time range by specifying either or combination of both latest
and oldest
.
If a message has the same timestamp as latest
or oldest
it will not be
included in the list. This allows a client to
fetch all messages in a hole in channel history, by calling conversations.replies
with latest
set to the oldest message they have after the hole, and oldest
to the latest message they have before the hole. However, you can cover the hole and include the exact moment of the specified timestamp, set inclusive
to true
. The inclusive
is ignored when latest
or oldest
is not specified.
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 for |
thread_not_found | Value for |
missing_scope | The token used is not granted the specific scope permissions required to complete this request. |
invalid_cursor | Value passed for |
invalid_ts_latest | Value passed for |
invalid_ts_oldest | Value passed for |
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. |
not_allowed_token_type | The token type used in this request is not allowed. |
method_deprecated | The method has been deprecated. |
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 |
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 |
invalid_form_data | The method was called via a |
invalid_post_type | The method was called via a |
missing_post_type | The method was called via a |
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 |
accesslimited | Access to this method is limited on the current network |
request_timeout | The method was called via a |
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 |
superfluous_charset | The method was called via a |