Message Persistence

Message Persistence reliably stores messages as they are published. You can easily retrieve messages that arrive while a device is offline. Set retention for specific periods or unlimited time.

Network interruptions

PubNub automatically reconnects after interruptions for a smooth experience. See the Connection Management guide for retry and backoff details.

When a message is published, PubNub stores it with the channel name and the message’s publish timetoken. You can use this data to retrieve, delete, or annotate messages.

You can retrieve the following:

• Messages
• Message reactions
• File Sharing

Configuration

Enable Message Persistence for your app’s keyset in the Admin Portal. For retention options, see Message retention.

Public Admin Portal demo

Want to browse through the Admin Portal without creating an account? Explore it through the Public Demo that shows examples of most PubNub features for transport and logistics use case.

By default, Message Persistence is enabled on every newly created keyset. Testing keysets default to 7 days retention. Retention is how long messages remain in storage before deletion. For retention options, see Message retention.

Option	Description
Retention	How long messages are saved. Free accounts support 1 day or 7 days. Paid accounts support higher limits. Align message retention with your File Sharing settings to keep messages and files for the same duration.
Enable Delete-From-History	A setting that lets you use API calls to delete specific messages previously stored in a channel's message history.
Include presence events	Includes Presence events in saved history so you can track them later.

Message retention

To retain a message, make sure Message Persistence is enabled for the target keyset in the Admin Portal. You may also configure the retention duration, enable Delete-From-History, and choose whether to retain Presence events. Once configured, Message Persistence is enabled for all channels in the keyset.

Immutable message retention

Retention settings apply to future messages only. When you update Message Persistence retention, existing messages keep their original retention period. New messages use the updated retention period.

Retrieve messages

Use the Message Persistence API to retrieve messages quickly. Get up to 100 for one channel, or 25 across up to 500 channels, in one request.

The Message Persistence API returns regular messages, file messages, and message actions. The messageType and custom_message_type values indicate the PubNub type (integer) and your custom type (string). Use these values to tag messages (text, signals, files) and later filter or group them.

Message Persistence enables retrieval of three data types stored in PubNub channels: messages, message actions, and file messages.

Message Type	Description	Saved in Message Persistence
0	Regular message	Yes
1	Signal	No
2	App Context event	No
3	Message Actions event	Yes
4	File message	Yes

Retrieving message actions

Retrieve messages with their actions, or retrieve only the actions. See Retrieve Actions for details.

Use start and end timetokens to get a time range. For multi‑channel requests, 25 is the default and maximum.

To fetch missed messages, provide only end with the last received timetoken. The example below retrieves the last 25 messages on two channels.

JavaScript

pubnub.fetchMessages(
  {
    channels: ["chats.room1", "chats.room2"],
    end: '15343325004275466',
    count: 25 // default/max is 25 messages for multiple channels (up to 500)
  },
  function(status, response) {
    console.log(status, response);
  }
);

Swift

pubnub.fetchMessageHistory(
  for: ["chats.room1", "chats.room2"],
  end: "15343325004275466"
) { result in
  switch result {
    case let .success(response):
      print("Successful History Fetch Response: \(response)")

    case let .failure(error):
      print("Failed History Fetch Response: \(error.localizedDescription)")
  }
}

Objective-C

self.pubnub.history()
  .channels(@[@"chats.room1", @"chats.room2"])
  .end(15343325004275466).limit(25)
  .performWithCompletion(^(PNHistoryResult *result, PNErrorStatus *status) {
    // handle returned messages in result
});

Java

pubNub.fetchMessages()
    .channels(Arrays.asList("ch1", "ch2", "ch3"))
    .async(result -> {
        result.onSuccess(res -> {
                final Map<String, List<PNFetchMessageItem>> channelToMessageItemsMap = res.getChannels();
                final Set<String> channels = channelToMessageItemsMap.keySet();
                for (final String channel : channels) {
                    List<PNFetchMessageItem> pnFetchMessageItems = channelToMessageItemsMap.get(channel);
                    for (final PNFetchMessageItem fetchMessageItem: pnFetchMessageItems) {
                        System.out.println(fetchMessageItem.getMessage());
                        System.out.println(fetchMessageItem.getMeta());
                        System.out.println(fetchMessageItem.getTimetoken());
                    }
                }
        }).onFailure(exception -> {

show all 18 lines

C#

pubnub.FetchHistory()
  .Channels(new string[] { "my_channel" })
  .MaximumPerChannel(25)
  .End(15343325004275466)
  .Execute(new PNFetchHistoryResultExt((result, status) => {
    // handle returned messages in result
  }));

Python

envelope = pubnub.fetch_messages()\
  .channels(["chats.room1", "chats.room2"])\
  .count(25)\
  .end(15343325004275466)\
  .sync()

If you need more than 25 messages, use returned timetokens to page backward and retrieve more. Continue paging through the channel timeline until you have all required messages.

Parameters Used	Behavior
start	Retrieves messages before the start timetoken, excluding any message at that timetoken
end	Retrieves messages after the end timetoken, including any message at that timetoken
start & end	Retrieves messages between the start and end timetokens, excluding any message at the start timetoken and including any message at the end timetoken

Convert Unix timestamps to PubNub timetokens with the converter tool.

Unix Timestamp (seconds)

Filtering retrieved messages

Message Persistence prioritizes low‑latency retrieval. To filter by content, retrieve messages and filter on the client. You can also filter by the type and custom_message_type values to show specific message types that you used previously (for example, vip-chat or intruder-alert). For server‑side search, use an After Publish Function to index messages in your database.

Alternatively, you can implement a self‑hosted server and use the After Publish Function to automatically send messages to your database and filter them on the server.

For more information or assistance, contact support.

Delete messages from history

Message Persistence lets you delete messages from history. You can delete messages published between two points in time or delete a specific message.

Deleting messages from history requires SDK clients initialized with the secret key. Each SDK provides different methods. Consult the SDK documentation for reference.

For details on initializing PubNub with a secret key, see Application Configuration.

Receive messages and signals

When a message or signal is received by the client, it triggers a message or signal event. Refer to Receive Messages to learn how to act on these events.

How messages are fetched

The following details explain how messages are retrieved from Message Persistence based on the start and end parameters.

Scenario 1

Scenario 1 retrieves messages starting with the message stored before the start timetoken parameter value and continues until it has 25 messages or hits that oldest message (whichever comes first).

Parameter	Value
count	25
start	value provided
end	value not provided

Channel Timeline
oldest-message --------------- start-timetoken --------------- newest-message
[                   <--------]

Scenario 2

Parameter	Value
count	25
start	value not provided
end	value provided

Channel Timeline
oldest-message --------------- end-timetoken --------------- newest-message
                               [                    <---------------------]

Scenario 3

Parameter	Value
count	25
start	value provided
end	value provided

Channel Timeline
oldest-message ----- end-timetoken ----------------- start-timetoken ----- newest-message
                     [      <----------------------]

Get message counts

The Message Count API returns the number of messages sent after a given point in time. You can specify up to 100 channels in a single call.

Rather than retrieving lots of messages from hundreds of channels, you can get the number of missed messages and retrieve the messages later. For example, you can display the unread message count on channels that the client hasn't visited yet and retrieve those messages when the client actually visits the channel.

The Message Count API returns the number of messages sent for each channel greater than or equal to the provided timetoken. You can not specify a time range because it's only intended to give the number of messages since a given timetoken. Optionally, you can specify a different timetoken per channel or one timetoken to be applied to all channels.

Unlimited message retention

For keys with unlimited message retention enabled, this method considers only messages published in the last 30 days.

JavaScript

pubnub.messageCounts({
    channels: ["chats.room1", "chats.room2"],
    channelTimetokens: ['15518041524300251']
    }).then((response) => {
    console.log(response)
    }).catch((error) => {
    // handle error
  }
);

Swift

pubnub.messageCounts(
  channels: ["chats.room1", "chats.room2"]),
  timetoken: 15495750401727535
) { result in
  switch result {
    case let .success(response):
      print("Successful Message Count Response: \(response)")

    case let .failure(error):
      print("Failed Message Count Response: \(error.localizedDescription)")
  }
}

Objective-C

self.client.messageCounts().channels(@[@"chats.room1", @"chats.room2"])
  .timetokens(@[@(15495750401727535)])
  .performWithCompletion(^(PNMessageCountResult *result, PNErrorStatus *status) {

    if (!status.isError) {
      // Client state retrieved number of messages for channels.
    }
    else {
      // handler error condition
    }
  });

Java

pubnub.messageCounts()
    .channels(Arrays.asList("chats.room1", "chats.room2"))
    .channelsTimetoken(Arrays.asList(15495750401727535L))
    .async(result -> {
        result.onSuccess(res -> {
            for (Map.Entry<String, Long> entry : res.getChannels().entrySet()) {
                entry.getKey(); // the channel name
                entry.getValue(); // number of messages for that channel
            }
        }).onFailure(exception -> {
            exception.printStackTrace();
        });
    });

C#

pubnub.MessageCounts()
  .Channels(new string[] { "chats.room1", "chats.room2" })
  .ChannelsTimetoken(new long[] { 15495750401727535 })
  .Execute(new PNMessageCountResultExt((result, status) => {
    if (status != null && status.Error)
    {
      Console.WriteLine(status.ErrorData.Information);
    }
    else
    {
      Console.WriteLine(pubnub.JsonPluggableLibrary.SerializeToJsonString(result));
    }
  }));

Python

envelope = pubnub.message_counts()\
  .channel("chats.room1", "chats.room2") \
  .channel_timetokens([15495750401727535])
  .sync()

print(envelope.result.channels)