Retrieving Pending Push Messages

Overview

This method will list all pending push messages that a user may have.

URL

Parameters on the following URL are inside braces { }

{base_url}/rest/api/tools/getPendingMessages/{instanceId}/{to}/{appName}/{platform}/{publicKey}/{signature}

Parameter Name	Description
instanceId	An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
to	The interested User's mobile phone number or User's deviceId
appName	The interested App's name
platform	The interested platform. Valid values: ANDROID or IOS
publicKey	The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature	The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getPendingMessages</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<blastId>-2490820026197535447</blastId>
			<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
			<type>PUSH</type>
			<from>Inbox</from>
			<to>13056708084</to>
			<subject>Inbox Push Ogangi</subject>
			<text>Inbox Push Ogangi Message</text>
			<status>SENT</status>
			<statusDescription>Sent</statusDescription>
			<date>2014-01-24T12:45:50.903-04:30</date>
			<timezone>America/Caracas</timezone>
			<appName>Inbox</appName>
			<platform>IOS</platform>
		</message>
 
		...
 
		<message>
			<blastId>-564646154894654545</blastId>
			<id>489cf77-4fbc-4822-a5ed-21516555fd1e</id>
			<type>PUSH</type>
			<from>testApp</from>
			<to>18133210984</to>
			<subject>testApp Push Ogangi</subject>
			<text>Inbox Push Ogangi</text>
			<status>SENDING</status>
			<statusDescription> Sending to device </statusDescription>
			<date>2014-01-24T12:45:50.903-04:35</date>
			<timezone>America/Caracas</timezone>
			<appName>Inbox</appName>
			<platform>IOS</platform>
		</message>
	</messages>
</result>

Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name	Description	Possible Values
message.blastId	Unique identifier for the blast used to fire the message	Text
message.id	Unique identifier for the message created	Text
message.type	Indicates the kind of message that was sent	PUSH SMS EMAIL
message.from	Who sent the message	for PUSH, Application that sent the message for SMS, Short/Long code which originated the message for EMAIL, the email address which sent the message.
message.to	Recipient for this message	Any of the following: deviceId mobile number email address
message.subject	Message's subject	Text
message.text	Message's content	Text
message.status	Indicates the message's status at the origination moment	See our Message's Status page
message.statusDescription	A human readable explanation about the current status	Text
message.date	Time mark at the origination moment	A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ For more information please review the pattern letters quick reference
message.timezone	Timezone used	Text
message.appName	App used, only available when using PUSH	Text
message.platform	App platform, only available when using PUSH	Text

Overview

Use this method to get the current user list that your App have.

You could use this information to maintaining statistic about how your audience grows

URL

Parameters on the following URL are inside braces { }

{base_url}/rest/api/tools/getApplicationsUsersList/{instanceId}/{appName}/{platform}/{publicKey}/{signature}

Parameter Name	Description
instanceId	An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
appName	The interested App's name
platform	The interested platform. Valid values: ANDROID or IOS
publicKey	The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature	The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>getApplicationsUsersList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<users>
		<user>
			<deviceId>92GFS-QWEJS-68AS-KSI87-09ASD21</deviceId>
			<appName>test</appName>
			<platform>ios</platform>
			<info>
				<entry>
					<key>device_token</key>
					<value>kajshdkjahkajdhakjdhaksjdhkj21h3123jhaskjdh9adaj1lksajd</value>
				</entry>
			</info>
		</user>
 
		...
 
		<user>
			<deviceId>12ABCD-345EF-67GH-89IJK-LMNOPQ10</deviceId>
			<appName>test</appName>
			<platform>ios</platform>
			<info>
				<entry>
					<key>device_token</key>
					<value>12abcd345ef67gh89ijklmnopq1012abcd345ef67gh89ijklmnopq10</value>
				</entry>
			</info>
		</user>
	</users>
</result>

Result parameters

Please be aware that the <user> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name	Description	Possible Values
user.deviceId	The (registered) device identifier.	Text
user.appName	App in which the user is registered	Text
user.platform	Platform in which the user is registered	Text
user.info	It's a map (key - value) which contains information collected about the user along his interactions with the App & with the Campaign Manager This map could contain multiple <entry> tags, each one with some piece of information	Text

Retrieving Pending Push Messages

Overview

URL

Response

Result parameters

Retrieving Application's Users List

Overview

URL

Response

Result parameters