RESTful API

Remove from Restriction List by Id

Overview

Remove a recipient from a restricted list using its list's id instead of the contact information.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/tools/removeOfRestrictionListById/{instanceId}/{id}/{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
id Recipient id on the restricted list
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>removeOfRestrictionListById</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 recipient was removed from the restriction list true
false
message A human readable explanation Text

Retrieving Restriction List

Overview

Retrieve the client's restriction list by source.

URL

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/tools/getRestrictionList/{instanceId}/{page}/{resultsPerPage}/{messageType}/{typeList}/{source}/{parameters}/{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
page This is a paginated method, so please use page to indicate the actual page you want to retrieve.
resultsPerPage How many results to show per page. Note that this will affect the total amount of pages
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
parameters
OPTIONAL		 Search filters. Please learn more about it in the restriction list search parameters appendix
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

If you don't want to use any OPTIONAL parameter you just need to write null on that particular placeholder.

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>getRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<restrictionList>
	<records>2</records> 
	<usersList>
		<user>
			<id>3</id>
        		<user>restriction@ogangi.com</user>
        		<reason>BOUNCED</reason>
		</user>  
 
		...
 
	</usersList>       
</restrictionList>
</result>
Result parameters
Parameter Name Description Possible Values
userlist This is the user list tag XML
user.id The id for the user in the list Number
user.user The recipient content information Text
user.reason The reason used at the insertion/update time Text