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

====== Campaign Broadcast ======

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

==== Overview ====

Send a broadcast to a campaign's users.

==== URL ====

Parameters on the following URL are inside braces { }
  {base_url}/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 [[misc:otto|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 [[restapi:campaigns#list_campaigns|List Campaigns]] |
| userName | The user name who owns the campaign. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| text | The Desired text. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| shortcode | The short/long code to use |
| shortcodeIgnore | A Boolean, if false the shortcode parameter will be ignored |
| initialDate \\ <wrap notice>OPTIONAL</wrap> | The start date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap>  |
| finalDate \\ <wrap notice>OPTIONAL</wrap> | The end date to use. \\ <wrap info>A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference </wrap> \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| textSearch \\ <wrap notice>OPTIONAL</wrap> | Text to search \\ <wrap info>Use **null** to ignore this parameter</wrap>. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| mobileNumber \\ <wrap notice>OPTIONAL</wrap> | The desired mobile number \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| carrierId \\ <wrap notice>OPTIONAL</wrap> | The desired carrier ID \\ <wrap info>Use **null** to ignore this parameter</wrap> |
| 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>sendOnAirBroadcast</input>
<status>OK</status>
<description>Completed</description>

</code>