Get message history with actions
Show history messages within the given time range, along with their actions.
The response is a list of messages, ordered by ascending
timetoken, wherein some of the message objects may by augmented with actions.
The actions for a given
messageare organized first by type, then by value. For a given (type, value) pair, all the unique UUIDs who posted that action will be shown, along with the
timetokenwhen the post occurred. Pagination can be controlled with
maxparameters, similar to the
The server may truncate the number of messages in the response, due to internal limits on the number of queries which can be performed per request. However, the server will always give "complete" messages, in the sense that the messages returned here will always have all their actions. If truncation of the original query occurs, a
morelink will be provided. This indicates that internal limiting has occurred, and the more link itself can be used to continue fetching the originally requested range of messages.
Consider the scenario where most messages have relatively few actions (<
250), but the first message has somehow accumulated 25000 actions. If the user requests
25 messages with actions, the first request to history with actions would return only the first message, with all of its 25000 actions underneath it, and provide a
more link to signal that truncation has occurred. Then the next request would contain the other 24 messages along with all their actions.
Your app's subscribe key from Admin Portal.
The channel name to perform the operation on.
Timetoken delimiting the start of time slice (exclusive) to pull messages from.
If provided, lets you select a start date, in Timetoken format. If not provided, it will default to current time. Page through results by providing a start OR end time token. Retrieve a slice of the time line by providing both a start AND end time token. start is exclusive, that is, the first item returned will be the one immediately after the start Timetoken value.
Timetoken delimiting the end of time slice (inclusive) to pull messages from.
If provided, lets you select an end date, in Timetoken format. Page through results by providing a start OR end time token. Retrieve a slice of the time line by providing both a start AND end time token. End is inclusive, that is, if a message is associated exactly with the end Timetoken, it will be included in the result.
The max number of messages to return. Default (and maximum value) is 100 messages where number of channels is 1, and 25 messages for any number of channels greater than one (or when retrieving message actions). The batch history is limited to 500 channels.
Set to true to include metadata with returned messages. This metadata is set using the meta parameter with the publish operation. Default is false.
Set to true to include uuid with returned messages. This is set using the uuid parameter with the publish operation. Default is false.
Set to true to include pubnub message type with returned messages. Default is false.
Set to true to include user message type with returned messages. Default is false.
Set to true to include space_id with returned messages. Default is false.
String which is either the auth key (PAM v2) or a valid token (Access Manager) used to authorize the operation if access control is enabled.
Example: authKey / p0thisAkFl043rhDdHRsCkNyZXisRGNoYW6hanNlY3JldAFDZ3Jwsample3KgQ3NwY6BDcGF0pERjaGFuoENnctokenVzcqBDc3BjoERtZXRhoENzaWdYIGOAeTyWGJI
A UTF-8 encoded string of up to 64 characters used to identify the client.
Signature used to verify that the request was signed with the secret key associated with the subscriber key.
If Access Manager is enabled, either a valid authorization token or a signature are required.
See Access Manager documentation for details on how to compute the signature.
Unix epoch timestamp used as a nonce for signature computation. Must have no more than ± 60 second offset from NTP.
The request was invalid.