RESTful API

Create Email List

Previous Versions

Overview

Create an empty email list.

URL

Http access method: POST

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/emailList/{instanceId}/{name}/{userName}/{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
name Name of the email list. This parameter must be Base64 encoded
userName Name of the user who creates the email list. This parameter must be Base64 encoded
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>createEmailList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <emaillist>
        <id>0101</id>
        <name>EmailListName</name>
    </emaillist>
</result>
Result parameters
Parameter Name Description Possible Values
emaillist.id Email list ID Number
emaillist.name Email list name Text

Get Email List

Overview

Obtains Email List NAME and ID given the name or obtains all Email Lists in a workspace if name is null.

URL

Http access method: GET

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/emailList/{instanceId}/{name}/{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
name Name of the email list. This parameter must be Base64 encoded.
OPTIONAL
Use null to get all Lists present in this workspace
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>getEmailList</input>
<status>OK</status>
<description>Completed</description>
<result>
    <emaillist>
        <id>0101</id>
        <name>EmailListName</name>
    </emaillist>
</result>
Result parameters
Parameter Name Description Possible Values
emaillist.id Email list ID Number
emaillist.name Email list name Text