RESTful API

User Blacklisted

Overview

Show if an user is in the black list

URL

Http access method: GET

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/isUserInBlackList/{instanceId}/{mobilenumber}/{shortcode}/{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
mobilenumber The mobile number to search in the blacklist.
shortcode Long or short code to search. If you don't have one assigned yet please contact our support team trough our ticketing tool to request one. Use -1 to add the mobile number in all Long or short codes of the instance.
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>exitsUserInBlackList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <userBlackList>
         <text>true</text>		
         <blackListType>1</blackListType>
    </userBlackList>
</result>
Result parameters

Please be aware that the <userBlackList> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
userBlackList.text Mobile number added in the blackList String
userBlackList.blackListType The blacklist type. If the user is not in the black list, this tag will no appear See our Blacklist Status page

Add User to blacklist

Overview

Allows add a user into the blacklist

URL

Http access method: POST

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/addUserToBlackList/{instanceId}/{mobilenumber}/{shortcode}/{blackListType}/{text}/{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
mobilenumber The mobile number to add in the blacklist.
shortcode Long or short code to add the mobile number. If you don't have one assigned yet please contact our support team trough our ticketing tool to request one. Use -1 to add the mobile number in all Long or short codes of the instance.
blackListType User 1 to MO, 2 to MT and 3 for both types.
text Comment about insertion.
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>addUserToBlackList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <userBlackList>
         <mobilenumber>123456789</mobilenumber>	
         <shortcode>DEVELOPMENT</shortcode>	
         <blackListType>1</blackListType>
         <date>23-09-2016 09:57:07</date>
    </userBlackList>
</result>
Result parameters

Please be aware that the <userBlackList> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
userBlackList.mobilenumber Mobile number added in the blackList String
userBlackList.shortcode Long or Shortcode where the mobile number was added String
userBlackList.date Date when the number was added to the black list Date
userBlackList.blackListType The blacklist type. See our Blacklist Status page

Remove User From Blacklist

Overview

Removes an user from the blacklist for a given shortcode

URL

Http access method: GET

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/removeUserFromBlackList/{instanceId}/{mobilenumber}/{shortcode}/{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
mobilenumber The mobile number to be removed from the blacklist.
shortcode Long or short code related to the blacklist.
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>removeUserFromBlackList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <userBlackList>
         <mobilenumber>123456789</mobilenumber>	
         <shortcode>DEVELOPMENT</shortcode>	
         <blackListType>1</blackListType>
    </userBlackList>
</result>
Result parameters

Please be aware that the <userBlackList> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
userBlackList.mobilenumber Mobile number removed from the blackList String
userBlackList.shortcode Long or Shortcode where the mobile number was removed String
userBlackList.blackListType The blacklist type. See our Blacklist Status page