RESTful API

Send Response (Tag 34)

Overview

If you are developing your own Android or iOS application you could use this method to allow users to give you some direct feedback through your Callback URL.

URL

Parameters on the following URL are inside braces { }

{base_url}/rest/api/tools/sendResponse/{instanceId}/{appName}/{from}/{platform}/{msgContent}/{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 Your App's name which will receive your Push Notifications
from SenderĀ“s phone number or device id.
platform The target platform for the push service. Valid values are: ANDROID or IOS
msgContent The content of the message per se. This parameter must be Base64 encoded. You can't exceed 200 characters
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>sendResponse</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the registration was successful or not true
false
message A human readable explanation Text