Add User to Distribution List
Overview
Add a mobile number to a distribution list.
URL
Parameters on the following URL are inside braces { }
{base_url}/rest/api/addUserDistributionList/{instanceId}/{distListId}/{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 |
| distListId | Target distribution list |
| mobileNumber | The mobile number to add. |
| 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>addUserDistributionList</input> <status>OK</status> <description>Completed</description>
Remove User from Distribution List
Overview
Remove a mobile number from a distribution list.
URL
Parameters on the following URL are inside braces { }
{base_url}/rest/api/removeUserDistributionList/{instanceId}/{distListId}/{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 |
| distListId | Target distribution list |
| mobileNumber | The mobile number to remove |
| 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>removeUserDistributionList</input> <status>OK</status> <description>Completed</description>
