RESTful API

Campaign Broadcast

Previous Versions

Overview

Send a broadcast to a campaign's users.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/sendOnAirBroadcast/{instanceId}/{mimId}/{userName}/{text}/{shortcode}/{shortcodeIgnore}/{initialDate}/{finalDate}/{textSearch}/{mobileNumber}/{carrierId}/{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
mimId The campaign id, you could retrieve this information from the campaign manager UI or using the List Campaigns
userName The user name who owns the campaign. This parameter must be Base64 encoded
text The Desired text. This parameter must be Base64 encoded
shortcode The short/long code to use
shortcodeIgnore A Boolean, if false the shortcode parameter will be ignored
initialDate
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
finalDate
OPTIONAL
The end 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
textSearch
OPTIONAL
Text to search
Use null to ignore this parameter. This parameter must be Base64 encoded
mobileNumber
OPTIONAL
The desired mobile number
Use null to ignore this parameter
carrierId
OPTIONAL
The desired carrier ID
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>sendOnAirBroadcast</input>
<status>OK</status>
<description>Completed</description>