RESTful API

List Broadcasts

Previous Versions

Tag 34

Overview

List broadcasts by instance.

URL

Http access method: GET

Parameters on the following URL are inside braces { } 

{base_url}/rest/api/broadcasts/{instanceId}/{type}/{initialDate}/{finalDate}/{text}/{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
type Related to the broadcast channel. See our Broadcast Types and Status section for more information
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
text
OPTIONAL 		Text to search. This parameter must be Base64 encoded
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>getBroadcasts</input>
<status>OK</status>
<description>Completed</description>
<result>
	<broadcasts>
	<broadcast>
		<id>1</id>
		<text>Test message</text>
		<startDate>2013-09-04T15:15:00-04:00</startDate>
		<endDate>2013-09-05T14:45:57-04:00</endDate>
		<expectedMessages>2</expectedMessages>
		<sentMessages>2</sentMessages>
		<status>2</status>
		<shortcode>0000000</shortcode>
	</broadcast>
 
	...
 
	<broadcast>
		<id>2</id>
		<text>Test message 2</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>
	</broadcasts>
</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.endDate Finished time mark Date
broadcast.expectedMessages Expected messages Number
broadcast.sentMessages 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