RESTful API

Send Email

Overview

Send a email message

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendEmail/{instanceId}/{from}/{to}/{subject}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

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
from The sending email's address. This parameter must be Base64 encoded.
to Recipient's email address. This parameter must be Base64 encoded.
subject The email's subject. This parameter must be Base64 encoded.
content
POST
A file that contains the content for your email message. This is a text file that could contain HTML format
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>sendEmail</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<type>EMAIL</type>
		<statusDescription>Sending to the recipient</statusDescription>
		<clientId>As223sdadq8d8287v5v</clientId>
		<timezone>America/Caracas</timezone>
		<initialDate>2014-11-27T15:43:58.692-04:30</initialDate>
		<endDate>2014-11-27T15:43:58.723-04:30</endDate>
		<messages>
			<message>
				<blastId>-2490820026197535447</blastId>
				<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
				<type>PUSH</type>
				<from>Inbox</from>
				<to>13056708084</to>
				<subject>Inbox Push Ogangi</subject>
				<text>Inbox Push Ogangi Message</text>
				<status>SENT</status>
				<statusDescription>Sent</statusDescription>
				<date>2014-01-24T12:45:50.903-04:30</date>
				<timezone>America/Caracas</timezone>
			</message>
		</messages>
	</blast>
</result>
Result parameters

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

Parameter Name Description Possible Values
blastId The unique blast identification, a blast is always needed to send one or more messages Text
status Indicates current the blast's status For more information please review the Message's Status page
type The blast's type EMAIL
statusDescription A human readable explanation about the blast's status Text
clientId The client identification (sender) Text
timezone Timezone used for this blast Text
initialDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
endDate Time mark at the culmination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.blastId Unique identifier for the blast used to fire the message Text
message.id Unique identifier for the message created Text
message.type Indicates the kind of message that was sent PUSH
SMS
EMAIL
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.subject Message's subject Text
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A human readable explanation about the current status Text
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text

Email Blast by File

Overview

Send Email massively using as recipient a list of mobile numbers.

The recipient list its a File (text or excel). Please read the Email Recipient List to learn more about this.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/sendEmailByFile/{instanceId}/{from}/{subject}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

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
from The sending email's address. This parameter must be Base64 encoded.
subject The email's subject. This parameter must be Base64 encoded.
to
POST
Recipients who will receive the message. Please read the Email Recipient List for more information about the recipient's file
content
POST
A file that contains the content for your email message. This is a text file that could contain HTML format
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>sendEmailByFile</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<type>EMAIL</type>
		<statusDescription>Sending to the recipient</statusDescription>
		<clientId>As223sdadq8d8287v5v</clientId>
		<timezone>America/Caracas</timezone>
		<initialDate>2014-11-27T15:43:58.692-04:30</initialDate>
		<endDate>2014-11-27T15:43:58.723-04:30</endDate>
		<messages>
			<message>
				<blastId>-2490820026197535447</blastId>
				<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
				<type>PUSH</type>
				<from>Inbox</from>
				<to>13056708084</to>
				<subject>Inbox Push Ogangi</subject>
				<text>Inbox Push Ogangi Message</text>
				<status>SENT</status>
				<statusDescription>Sent</statusDescription>
				<date>2014-01-24T12:45:50.903-04:30</date>
				<timezone>America/Caracas</timezone>
			</message>
 
			...
 
			<message>
				<blastId>-564646154894654545</blastId>
				<id>489cf77-4fbc-4822-a5ed-21516555fd1e</id>
				<type>PUSH</type>
				<from>testApp</from>
				<to>18133210984</to>
				<subject>testApp Push Ogangi</subject>
				<text>testApp Push Ogangi Message</text>
				<status>SENDING</status>
				<statusDescription> Sending to device </statusDescription>
				<date>2014-01-24T12:45:50.903-04:35</date>
				<timezone>America/Caracas</timezone>
			</message>
		</messages>
	</blast>
</result>
Result parameters

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

Parameter Name Description Possible Values
blastId The unique blast identification, a blast is always needed to send one or more messages Text
status Indicates current the blast's status For more information please review the Message's Status page
type The blast's type EMAIL
statusDescription A human readable explanation about the blast's status Text
clientId The client identification (sender) Text
timezone Timezone used for this blast Text
initialDate Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
endDate Time mark at the culmination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.blastId Unique identifier for the blast used to fire the message Text
message.id Unique identifier for the message created Text
message.type Indicates the kind of message that was sent PUSH
SMS
EMAIL
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.subject Message's subject Text
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A human readable explanation about the current status Text
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text

Email Blast by List

Overview

Send Email massively using as recipient a list of email addresses previously created on a workspace.

The recipient list its an Email List previously created on the sending workspace.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/sendEmailByList/{instanceId}/{emailListId}/{userName}/{subject}/{date}/{hour}/{publicKey}/{signature}

Please note that on the URL you won't see any POST parameters, only the regular parameters
All POST parameters will be highlighted in the following table.

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
emailListId Target email list
userName Name of the user who creates the email Blast. This parameter must be Base64 encoded
subject The email's subject. This parameter must be Base64 encoded.
date
OPTIONAL
The start date to use.
A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference
Use null to ignore this parameter
hour
OPTIONAL
The desired hour to start the broadcast.
A formatted date string: HH:mm For more information please review the pattern letters quick reference
Use null to ignore this parameter
content
POST
A file that contains the content for your email message. This is a text file that could contain HTML format
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>sendEmailByList</input>
<status>OK</status>
<description>Completed</description>