//[[restapi:start|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 [[misc:otto|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 [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>removeOfRestrictionListById</input>
<status>OK</status>
<description>Completed</description>
<result>
	<transactionResult> 
		<successful>true</successful>
		<message>Successful registration</message>
	</transactionResult>
</result>

</code>

== Result parameters ==

^ Parameter Name ^ Description ^ Possible Values ^
| successful | Indicates if the recipient was removed from the restriction list | <color blue>true</color> \\ <color red>false</color> |
| 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 [[misc:otto|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. <wrap info>Valid Values are : SMS, EMAIL, PUSH or VOICE.</wrap> | 
| typeList | Type of restriction list. <wrap info>Valid Values are: WHITE or BLACK</wrap> | 
| source | If you want to consider multiples codes to block/allow the recipient |
| parameters \\ <wrap notice>OPTIONAL</wrap>| Search filters. Please learn more about it in the [[restapi:appx_rl_search|restriction list search parameters]] appendix |
| publicKey | The public key to access this API. //if you don't know yours please request it using our [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|Java Example]] |

<WRAP round tip>
If you don't want to use any **<color blue>OPTIONAL</color>** parameter you just need to write **null** on that particular placeholder.
</WRAP>

==== 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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<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>

</code>

== 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 |