Skip to main content

lib/slack/web/docs/conversations.history.json

{
  "desc": "Returns a portion of message events from the specified conversation.\n\nBot 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.",

  "args": {
    "channel": {
      "example" : "G1234567890",
      "required": true,
      "desc"    : "Conversation ID to fetch history for."
    },
    "cursor": {
      "example" : "dXNlcjpVMDYxTkZUVDI=",
      "required": false,
      "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."
    },
    "inclusive": {
      "example" : "true",
      "required": false,
      "desc"    : "Include messages with latest or oldest timestamp in results only when either timestamp is specified.",
      "default" : 0
    },
    "latest": {
      "example" : "1234567890.123456",
      "required": false,
      "desc"    : "End of time range of messages to include in results.",
      "default" : "now"
    },
    "limit": {
      "example" : 20,
      "required": false,
      "desc"    : "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" : 100
    },
    "oldest": {
      "example" : "1234567890.123456",
      "required": false,
      "desc"    : "Start of time range of messages to include in results.",
      "default" : 0
    }
  },

  "errors": {
    "channel_not_found": "Value passed for `channel` was invalid"
  }
}