//[[restapi:start|RESTful API]]//

====== Add to Restriction List ======

==== Previous Versions ====
<wrap button>[[restapi:add_to_restriction_list_3_34|Tag 34]]</wrap>

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

<WRAP round tip>
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.
</WRAP>

==== 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 [[misc:otto|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 [[restapi:appx_ciphering#base64_-_encode|Base64 encoded]] | 
| 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> | 
| reason \\ <wrap notice>OPTIONAL</wrap> | Reason to add a user to a restriction list. <wrap info>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.</wrap> | 
| source | If you want to consider multiples codes to block/allow the recipient. This parameter must be [[restapi:appx_ciphering#base64_-_encode|Base64 encoded]] |
| 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>addUserToRestrictionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<users>
         <id>0</id>
         <user>restriction@ogangi.com</user>
         <reason>BOUNCED</reason>
      </users>
</result>

</code>

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