RESTful API

List Distribution List

Previous Versions

Tag 34

Overview

List the distribution list by instance

URL

Http access method: GET

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/distributionList/{instanceId}/{userName}/{mobileNumber}/{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
userName The user name that owns the lists. This parameter must be Base64 encoded
mobileNumber
OPTIONAL 		If used the result will also indicates if the given mobile number is already present on each distribution list listed
Use null to ignore this parameter
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>getDistributionList</input>
<status>OK</status>
<description>Completed</description>
<result>
	<distributionLists>
		<distributionlist>
			<id>1</id>
			<name> Distribution List 1</name>
			<subscribed>yes</subscribed>
		</distributionlist>
 
                ...
 
		<distributionlist>
			<id>2</id>
			<name>Distribution List 3</name>
			<subscribed>no</subscribed>
		</distributionlist>
	</distributionLists>
</result>
Result parameters
Parameter Name Description Possible Values
distributionlist.id Distribution list ID Number
distributionlist.name Distribution list name Text
distributionlist.subscribed If the mobile parameter was used it shows if the list contain that user Yes or No