Skip to content

Fetch All Messages from Volt MX Foundry Engagement Services

The Fetch All Messages from Volt MX Foundry Engagement Services API is used to get message content from the server based on the input parameters.

Important: The Fetch All Message Content from Volt MX Foundry Engagement Services API is maintained here to preserve backward compatibility.
We encourage you to use Fetch All Message Content from Volt MX Foundry Engagement Services

URL

The HTTP URL for Fetch All Messages from Volt MX Foundry Engagement Services API is:

http://<host or ip>:<port>/service/entrydata/fetchmessages

Method

POST

Input Parameters

This service takes input parameters in JSON formats.

  1. With KSID
{ "ksid": "VoltMXSubscriberID",  
      "startElement": "0",  
      "elementsPerPage": "10" }

- **ksid**: Volt MX Subscription ID returned when you subscribe to Volt MX Foundry Engagement Services.
- startElement: Starting element is a non-negative integer such as 0,1,2,3.
- elementsPerPage: Number of messages to be displayed per page.
  1. With DEVICEID and APPID
{ "deviceId": "123456",  
       "appId" : "VoltMX Foundry Messaging_APPLICATION_ID",  
      "startElement": "0",  
      "elementsPerPage": "10" }

- **deviceId**: Device ID of the Subscriber which was used when you subscribe to Volt MX Foundry Engagement Services.
- **appId**: Application ID in Volt MX Foundry Messaging Engagement Services.
- startElement: Starting element is a non-negative integer such as 0,1,2,3.
- elementsPerPage: Number of messages to be displayed per page.
  1. With UFID and APPID
{ "ufid": "xxx@gmail.com",  
       "appId": "VoltMX Foundry Messaging_APPLICATION_ID",  
      "startElement": "0",  
      "elementsPerPage": "10" }

- **ufid**: UFID of the subscriber which was used when you subscribe to Volt MX Foundry Engagement Services.
- **appId**: Application ID in Volt MX Foundry Engagement Services.
- startElement: Starting element is a non-negative integer such as 0,1,2,3.
- elementsPerPage: Number of messages to be displayed per page.

> **_Important:_** If the **Auth** t**oken** for **subscription** APItext box is enabled in the **Administration** \> **General** tab > **Security**, you need to append the authToken element in the JSON request for all the three formats.

Sample JSON with authToken

{ "ksid": "VoltMXSubscriberID",  
      "startElement": "0",  
      "elementsPerPage": "10",  
      "authToken":  "xxxxxx"}

Response

Success response code is "200".

Response will be a JSON with all Push messages sent to the Subscriber. Sample response is:

{"openedMessages":0,"submittedMessages":1,"totalMessages":1,"messages":[{"content":"This is a test push.","status":"Submitted","fetchid":"7530271640775557121"}]}
  • openedMessages: Number of Messages opened by subscriber.
  • submittedMessages: Number of messages successfully delivered to subscriber and not opened.
  • totalMessages: Total number of messages successfully delivered to subscriber.