Add to Restriction List

Previous Versions

Overview

The API support a global restriction list, clients can block traffic to a desired recipient by adding it to the restriction list, use this method to do so.

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.

URL

Parameters on the following URL are inside braces { }

{base_url}/rest/api/tools/addToRestrictionList/{instanceId}/{user}/{messageType}/{typeList}/{reason}/{source}/{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
user	Recipient (Email, phone number or device id) to add to the restriction list. This parameter must be Base64 encoded
messageType	Type of message. Valid Values are : SMS, EMAIL, PUSH or VOICE.
typeList	Type of restriction list. Valid Values are: WHITE or BLACK
reason OPTIONAL	Reason to add a user to a restriction list. Valid values are: BOUNCED \| COMPLAINED for email or UNREACHABLE for SMS, push or voice call. Use “null” if you do not want to use it.
source	If you want to consider multiples codes to block/allow the recipient. This parameter must be Base64 encoded
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>addUserToRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<users>
         <id>0</id>
         <user>restriction@ogangi.com</user>
         <reason>BOUNCED</reason>
      </users>
</result>

Result parameters

Parameter Name	Description	Possible Values
users.id	Unique identifier for the user in a restriction list	Number
users.user	User added into restriction list	Text
users.reason	Reason to add user into restriction list	Text