RESTful API

Inspect User Interaction for Multiple Choice

Overview

Inspect a user message flow in the given Multiple Choice

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getChoicesForMobileNumber/{instanceId}/{mobileNumber}/{initialDate}{finalDate}/{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
mobileNumber Desire mobile number to search
initialDate The starting date, all results will be after this date
A formatted date string: yyyyMMdd For more information please review the pattern letters quick reference
finalDate The final date, all results will be before this date
A formatted date string: yyyyMMdd For more information please review the pattern letters quick reference
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>getChoicesForMobileNumber</input>
<status>OK</status>
<description>Completed</description>
<result>
	<choice>
		<questionNumber></questionNumber>
		<questionText></questionText>
		<choiceNumber></choiceNumber>
		<choiceText></choiceText>
		<choiceDate></choiceDate>
		<pointsReward></pointsReward>
	</choice>
 
	. . . 
 
	<choice>
		<questionNumber></questionNumber>
		<questionText></questionText>
		<choiceNumber></choiceNumber>
		<choiceText></choiceText>
		<choiceDate></choiceDate>
		<pointsReward></pointsReward>
	</choice>
</result>
Result parameters
Parameter Name Description Possible Values
choice.questionNumber Current question index Number
choice.questionText Current question text Text
choice.choiceNumber User choice index Number
choice.choiceText User choice text Text
choice.choiceDate Time mark when the selection was made Date
choice.pointsReward Points awarded to the user about this selection Number

Inspect Ranking

Overview

Retrieve the current ranking stored in a distribution list. Please note that this distribution list could be attached to an active multiple choice and the result may vary on each call.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/getPointsRankingForDList/{instanceId}/{distListId}/{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
distListId The distribution list Id that holds a ranking table
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>getPointsRankingForDList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<subscriber>
		<position></position>
		<mobilenumber></mobilenumber>
		<points></points>
	</subscriber>
 
	... 
 
	<subscriber>
		<position></position>
		<mobilenumber></mobilenumber>
		<points></points>
	</subscriber>
</result>
Result parameters
Parameter Name Description Possible Values
subscriber.position Overall user position on table Number
subscriber.mobilenumber User's mobile number Text
subscriber.points User's points Number