RESTful API

Add to Restriction List (Bulk)

Previous Versions

Tag 34

Overview

The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, you can load big user's list at once using this method.

We support both white restriction list and black restriction list. Keep in mind that the whitelist recipients are allowed and the blacklist recipients are not.

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/tools/addToRestrictionListByFile/{instanceId}/{messageType}/{typeList}/{source}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

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
messageType Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList Type of restriction list. Valid Values are: WHITE or BLACK
source If you want to consider multiples codes to block/allow the recipient. This parameter must be Base64 encoded
file
POST 		Recipients who will receive the message. Please read the restriction list file format for more information about this text file
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>addUserToRestrictionListByFile</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult>
		<successful>true</successful>
		<message>Successful</message>
		<unsuccessful>
			<failedUser>jonhdoe@gmail.com</failedUser>
		</unsuccessful>
<transactionResult>
</result>
Result parameters
Parameter Name Description Possible Values
successful Indicates if the recipients were added to the restriction list true
false
message A human readable explanation Text
unsuccessful Recipients list that couldn't be added Text