RESTful API

Blast by File

Overview

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

The recipient list its a File (text or excel). Please read the SMSs 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/sendSMSByFile/{instanceId}/{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
file
POST
Recipients who will receive the message. Please read the phone list file guidelines for more information about this text file
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>sendSMS</input>
<status>OK</status>
<description>Completed</description>
<result>
	<messages>
		<message>
			<id>-6710228708174720670</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>18133210984</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2014-12-17T00:12:13.571-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
		...
 
		<message>
			<id>-8174720676710228700</id>
			<carrier>carrierName</carrier>
			<from>19893653744</from>
			<to>13056708084</to>
			<text>OGANGI TEST MESSAGE</text>
			<status>SENT_TO_CARRIER</status>
			<statusDescription>Sent to Carrier</statusDescription>
			<encoding>UTF-8</encoding>
			<date>2013-09-17T10:13:59.176-04:30</date>
			<timezone>America/Caracas</timezone>
			<clientId>As223sdadq8d8287v5v</clientId>
		</message>
 
	</messages>
</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
message.id Unique identifier for the message created Text
message.carrierName The carrier name used for this delivery Text
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.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 simple explanation about the message's status Text
message.encoding The charset encoding used for the message's text Valid encoding name
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
message.clientId The client identification (sender) Text

Lists Instance Codes

Overview

List all short/long codes for a given instance.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getShortcodes/{instanceId}/{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
userName The user name associated with 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>getShortcodes</input>
<status>OK</status>
<description>Completed</description>
<result>
	<shortcodes>
		<shortcode>
			<sc>0000000</sc>
		</shortcode>
 
		...
 
		<shortcode>
			<sc>1111111</sc>
		</shortcode>
        </shortcodes>
</result>
Result parameters
Parameter Name Description Possible Values
shortcode.sc The short/long code String

Create or Edit Broadcast From JSON

Overview

Create or edit a broadcast by file using JSON

This is a POST method, which means that you need to use it through a POST call

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/createBroadcastFromJson/{instanceId}/{broadcastId}/{shortcode}/{userName}/{shortcodeIgnore}/{campaignName}/{date}/{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
broadcastId The broadcast ID, provide a valid one if editing or -1 if new
shortcode The short/long code to use in this delivery
userName The user name that will own this broadcast
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
campaignName
OPTIONAL
Optional: A name for this campaign
date
OPTIONAL
Time & date to schedule the broadcast. formatted date string: dd-MM-yyyy HH:mm For more information please review the pattern letters quick reference Set this to null ff the broadcast is meant to start immediately
to
POST
Recipients who will receive the message. Please read the JSON recipient format for more information about this JSON
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>createBroadcastFromJson</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2016-08-16T17:49:42.346-04:002</startDate>
		<expectedMessages>2</expectedMessages>
		<statusDescription>SCHEDULED</statusDescription>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast ID Number
broadcast.text Broadcast's content Text
broadcast.startDate Starting time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages Sent messages count Number
broadcast.statusDescription Current broadcast status. See our Broadcast Types and Status section for more information Text
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Call Example

Please check the following link for examples on how to build the call for this method Json Call Example

Broadcast Detail

Overview

Retrieve the broadcast information.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/getBroadcast/{instanceId}/{broadcastId}/{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
broadcastId The broadcasts ID to consult
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>getBroadcast</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcast>
		<id>2</id>
		<text>message</text>
		<startDate>2013-09-05T15:10:14-04:00</startDate>
		<endDate>2013-09-05T15:10:14-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
</result>
Result parameters
Parameter Name Description Possible Values
broadcast.id The broadcast id Number
broadcast.text Content of the broadcast Text
broadcast.startDate Time mark when the broadcast starts Date
broadcast.endDate Time mark when the broadcast ends Date
broadcast.expectedMessages Expected messages on this broadcast Number
broadcast.sentMessages Already sent messages count Number
broadcast.status Current broadcast status. See our Broadcast Types and Status section for more information Number
broadcast.shortcode Short/Long Code through which the messages are going to be delivered Number

Suspend Broadcast

Overview

Suspend a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/suspendBroadcast/{instanceId}/{broadcastId}/{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
broadcastId The running broadcast ID to suspend
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>suspendBroadcast</input>
<status>OK</status>
<description>Completed</description>

Resume Broadcast

Overview

Resume a broadcast that was previously suspended.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/resumeBroadcast/{instanceId}/{broadcastId}/{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
broadcastId The broadcast ID to resume
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>resumeBroadcast</input>
<status>OK</status>
<description>Completed</description>

Stop Broadcast

Overview

Stop a broadcast currently in progress.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/stopBroadcast/{instanceId}/{broadcastId}/{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
broadcastId Running broadcast Id to stop
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>stopBroadcast</input>
<status>OK</status>
<description>Completed</description>

Delete Broadcast

Overview

Delete a broadcast.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/deleteBroadcast/{instanceId}/{broadcastId}/{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
broadcastId Broadcast ID to delete
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>deleteBroadcast</input>
<status>OK</status>
<description>Completed</description>