//[[restapi:start|RESTful API]]//

====== Create Broadcast By File ======

==== Previous Versions ====
<wrap button>[[restapi:create_broadcast_by_file_3_34|Tag 34]]</wrap>

==== Overview ====

Create a broadcast by file.

==== URL ====
Http access method: <wrap notice>POST</wrap>

Parameters on the following URL are inside braces { }
  {base_url}/rest/api/broadcastByFile/{instanceId}/{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 [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| shortcode | The short/long code to use in this delivery |
| userName | The user name that will own this broadcast. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| shortcodeIgnore | A Boolean, if false the shortcode parameter will be ignored |
| campaignName \\ <wrap notice>OPTIONAL</wrap> | Optional: A name for this campaign. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| date \\ <wrap notice>OPTIONAL</wrap> | The current time & date. <wrap info>formatted date string: **dd-MM-yyyy HH:mm** For more information please review the [[restapi:appx_date#date_format_-_pattern_letters|pattern letters]] quick reference</wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| to \\ <wrap notice>POST</wrap> | Recipients who will receive the message. Please read the [[restapi:appx_phonelist#smss_recipient_list__simple_|SMS recipient file format]] 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 [[misc:otto|ticketing tool]], you will need to provide your Mobile Engagement Campaign Manager's URL and your user login// |
| signature | The unique [[restapi:appx_ciphering#SHA256 - Cipher|SHA256]] signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our [[restapi:appx_call_ex|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 [[restapi:appx_resp_xml|Response XML Basics]] section if you want to learn more about the response parts.

<code xml>

<input>createBroadcastByFile</input>
<status>OK</status>
<description>Completed</description>
<result>
	<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>
</result>


</code>

== 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 [[restapi:appx_broadcast|Broadcast Types and Status]] section for more information | Number |
| broadcast.shortcode | Short/Long Code through which the messages are going to be delivered | Number |