Message Persistence API for JavaScript SDK

Message Persistence gives you real-time access to the history of messages published to PubNub. Each message is timestamped to the nearest 10 nanoseconds and stored across multiple availability zones in several geographic locations. You can encrypt stored messages with AES-256 so they are not readable on PubNub’s network. For details, see Message Persistence.

You control how long messages are stored through your account’s retention policy. Options include: 1 day, 7 days, 30 days, 3 months, 6 months, 1 year, or Unlimited.

You can retrieve the following:

  • Messages
  • Message reactions
  • Files (using the File Sharing API)
Supported and recommended asynchronous patterns

PubNub supports Callbacks, Promises, and Async/Await for asynchronous JS operations. The recommended pattern is Async/Await and all sample requests in this document are based on it. This pattern returns a status only on detecting an error. To receive the status errors, you must use the try...catch syntax in your code.

Fetch history

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Fetch historical messages from one or more channels. Use includeMessageActions to include message actions.

You can control how messages are returned and in what order.

  • If you specify only the start parameter (without end), you receive messages older than the start timetoken.
  • If you specify only the end parameter (without start), you receive messages from that end timetoken and newer.
  • If you specify both start and end, you retrieve messages between those timetokens (inclusive of the end value).

You can receive up to 100 messages for a single channel. For multiple channels (up to 500), you can receive up to 25 messages per channel. If more messages match the time range, make iterative calls and adjust the start timetoken to page through the results.

Method(s)

Use the following method(s) in the JavaScript SDK:

pubnub.fetchMessages({
channels: Array<string>,
count: number,
includeMessageType: boolean,
includeCustomMessageType: boolean,
includeUUID: boolean,
includeMeta: boolean,
includeMessageActions: boolean,
start: string,
end: string
})
* required
ParameterDescription
channels *
Type: Array<string>
Default:
n/a
Channels to fetch history messages from (up to 500).
count
Type: number
Default:
100 or 25
Number of historical messages to return per channel. Default is 100 (single) and 25 (multi) or 25 with includeMessageActions.
includeMessageType
Type: boolean
Default:
true
Whether to pass true to include message type. Default is true.
includeCustomMessageType
Type: Boolean
Default:
n/a
Whether to retrieve messages with the custom message type.

For more information, refer to Retrieving Messages.
includeUUID
Type: boolean
Default:
true
Whether to receive the publisher uuid. Default is true.
includeMeta
Type: boolean
Default:
n/a
Whether to include the meta object (if provided at publish time) in the response.
includeMessageActions
Type: boolean
Default:
n/a
Whether to retrieve history messages with message actions. If used, limit is 25 per single channel and only one channel is allowed. The response may be truncated; a more link is provided.
start
Type: string
Default:
n/a
Timetoken delimiting the start (exclusive) of the time slice.
end
Type: string
Default:
n/a
Timetoken delimiting the end (inclusive) of the time slice.
Truncated response

If you fetch messages with message actions, the response may be truncated when internal limits are reached. If truncated, a more property is returned with additional parameters. Make iterative calls to history, adjusting the parameters to fetch more messages.

Sample code

Reference code
This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

Retrieve a message from a channel:



Response

//Example of status
{
error: false,
operation: 'PNFetchMessagesOperation',
statusCode: 200
}

//Example of response
{
"channels":{
"my-channel":[
{
"message":"message_1",
"timetoken":"15483367794816642",
"uuid":"my-uuid",
show all 23 lines

Other examples

Fetch messages with metadata and actions


Fetch messages with metadata and actions response

Return information on message actions

To get information on actions taken on specific messages within a PubNub channel (like reactions, edits, deletions, or other custom-defined actions) use the actions object instead of the deprecated data object.

// Example of status
{
"error": false,
"operation": "PNFetchMessagesOperation",
"statusCode": 200
}

// Example of response
{
"channels":{
"my_channel":[
{
"channel : "my_channel",
"timetoken":"15741125155552287",
"message":{
show all 40 lines

Delete messages from history

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Remove messages from the history of a specific channel.

Required setting

Enable Delete-From-History for your key in the Admin Portal and initialize the SDK with a secret key.

Method(s)

To Delete Messages from History, you can use the following method(s) in the JavaScript SDK.

pubnub.deleteMessages({
channel: string,
start: string,
end: string
})
Method behavior

The Delete Messages method behaves slightly differently than other history methods. Note that the start parameter is exclusive and the end parameter is inclusive.

* required
ParameterDescription
channel *
Type: string
Specifies channel messages to be deleted from history.
start
Type: string
Timetoken delimiting the start of time slice (exclusive) to delete messages from.
end
Type: string
Timetoken delimiting the end of time slice (inclusive) to delete messages from.

Sample code


Response

{
error: false,
operation: 'PNDeleteMessagesOperation',
statusCode: 200
}

Other examples

Delete specific message from a Message Persistence

To delete a specific message, pass the publish timetoken (received from a successful publish) in the End parameter and timetoken +/- 1 in the Start parameter. For example, if 15526611838554310 is the publish timetoken, pass 15526611838554309 in Start and 15526611838554310 in End parameters respectively as shown in the following code snippet.


Message counts

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Return the number of messages published since the given time. The count is the number of messages with a timetoken greater than or equal to channelTimetokens.

Unlimited message retention

Only messages from the last 30 days are counted.

Method(s)

You can use the following method(s) in the JavaScript SDK:

pubnub.messageCounts({
channels: Array<string>,
channelTimetokens: Array<string>
})
* required
ParameterDescription
channels *
Type: Array<string>
Default:
n/a
Channels to fetch the message count.
channelTimetokens *
Type: Array<string>
Default:
n/a
Array in the same order as channels; a single timetoken applies to all channels; otherwise, lengths must match or the function returns a PNStatus error.

Sample code


Returns

Message count

Channels without messages have a count of 0. Channels with 10,000 messages or more have a count of 10000.

{
channels: {
ch1: 49
}
}

Status response

{
error: false,
operation: 'PNMessageCountsOperation',
statusCode: 200
}

Other examples

Retrieve count of messages using different timetokens for each channel


History (deprecated)

Requires Message Persistence

Enable Message Persistence for your key in the Admin Portal. See how to enable add-on features.

Alternative method

This method is deprecated. Use fetch history instead.

This function fetches historical messages of a channel.

It is possible to control how messages are returned and in what order, for example you can:

  • Search for messages starting on the newest end of the timeline (default behavior - reverse = false)
  • Search for messages from the oldest end of the timeline by setting reverse to true.
  • Page through results by providing a start OR end timetoken.
  • Retrieve a slice of the time line by providing both a start AND end timetoken.
  • Limit the number of messages to a specific quantity using the count parameter.
Start & End parameter usage clarity

If only the start parameter is specified (without end), you will receive messages that are older than and up to that start timetoken value. If only the end parameter is specified (without start) you will receive messages that match that end timetoken value and newer. Specifying values for both start and end parameters will return messages between those timetoken values (inclusive on the end value). Keep in mind that you will still receive a maximum of 100 messages even if there are more messages that meet the timetoken values. Iterative calls to history adjusting the start timetoken is necessary to page through the full set of results if more than 100 messages meet the timetoken values.

Method(s)

Use the following method(s) in the JavaScript SDK

pubnub.history({
channel: string,
reverse: boolean,
count: number,
stringifiedTimeToken: boolean,
includeMeta: boolean,
start: string,
end: string
})
* required
ParameterDescription
channel *
Type: string
Default:
n/a
Channel to return history messages from.
reverse
Type: boolean
Default:
false
Whether to traverse from oldest to newest. If both start and end are provided, reverse is ignored and messages return starting with the newest message.
count
Type: number
Default:
100
Number of historical messages to return. Default/Maximum is 100.
stringifiedTimeToken
Type: boolean
Default:
false
Whether to return timetokens as strings.
includeMeta
Type: boolean
Default:
n/a
Whether to include the meta object (if provided at publish time) in the response.
start
Type: string
Default:
n/a
Timetoken delimiting the start (exclusive) of the time slice.
end
Type: string
Default:
n/a
Timetoken delimiting the end (inclusive) of the time slice.
Using the reverse parameter:

Messages are always returned sorted in ascending time direction from history regardless of reverse. The reverse direction matters when you have more than 100 (or count, if it's set) messages in the time interval, in which case reverse determines the end of the time interval from which it should start retrieving the messages.

Sample code

Retrieve the last 100 messages on a channel:

try {
const result = await pubnub.history({
channel: "history_channel",
count: 100, // how many items to fetch
stringifiedTimeToken: true, // false is the default
});
} catch (status) {
console.log(status);
}

Response

// Example of Status
{
error: false,
operation: "PNHistoryOperation",
statusCode: 200
}

// Example of Response
{
endTimeToken: "14867650866860159",
messages: [
{
timetoken: "14867650866860159",
entry: "[User 636] hello World"
},
show all 21 lines

Other examples

Use history() to retrieve the three oldest messages by retrieving from the time line in reverse

try {
const result = await pubnub.history({
channel: "my_channel",
reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
count: 3, // how many items to fetch
stringifiedTimeToken: true, // false is the default
});
} catch (status) {
console.log(status);
}

Use history() to retrieve messages newer than a given timetoken by paging from oldest message to newest message starting at a single point in time (exclusive)

try {
const result = await pubnub.history({
channel: "my_channel",
reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
stringifiedTimeToken: true, // false is the default
start: "13406746780720711", // start timetoken to fetch
});
} catch (status) {
console.log(status);
}

Use history() to retrieve messages until a given timetoken by paging from newest message to oldest message until a specific end point in time (inclusive)

try {
const result = await pubnub.history({
channel: "my_channel",
stringifiedTimeToken: true, // false is the default
end: "13406746780720711", // start timetoken to fetch
});
} catch (status) {
console.log(status);
}

History paging example

Usage

You can call the method by passing nothing or a valid timetoken as the argument.

async function getAllMessages(initialTimetoken = 0) {
const allMessages = [];
let latestCount = 100;
let timetoken = initialTimetoken;

while (latestCount === 100) {
const { messages, startTimeToken, endTimeToken } = await pubnub.history(
{
channel: "history_test",
stringifiedTimeToken: true, // false is the default
start: timetoken, // start timetoken to fetch
}
);

latestCount = messages.length;
show all 28 lines

Fetch messages with metadata

try {
const result = await pubnub.history({
channel: "my_channel",
stringifiedTimeToken: true,
includeMeta: true,
});
} catch (status) {
console.log(status);
}

Sample code with promises

pubnub.history({
channel: 'history_channel',
reverse: true, // Setting to true will traverse the time line in reverse starting with the oldest message first.
count: 100, // how many items to fetch
stringifiedTimeToken: true, // false is the default
start: '123123123123', // start timetoken to fetch
end: '123123123133', // end timetoken to fetch
}).then((response) => {
console.log(response);
}).catch((error) => {
console.log(error);
});
Last updated on