Current section
Files
Jump to
Current section
Files
lib/slack/web/docs/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.\n\n0",
"example": "true",
"required": false,
"type": "boolean"
},
"inclusive": {
"desc": "Include messages with `oldest` or `latest` timestamps in results. Ignored unless either timestamp is specified.\n\n0",
"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": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"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.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"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.",
"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_arguments": "The method was called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"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.",
"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_cursor": "Value passed for `cursor` was not valid or is no longer valid.",
"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_metadata_filter_keys": "Value passed for `metadata_keys_to_include` was invalid. Must be valid json array of strings.",
"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`.",
"invalid_ts_latest": "Value passed for `latest` was invalid",
"invalid_ts_oldest": "Value passed for `oldest` was invalid",
"method_deprecated": "The method has been deprecated.",
"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.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"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.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"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.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.",
"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",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"two_factor_setup_required": "Two factor setup is required."
}
}