====== Create Broadcast by Distribution List Using Throttle and Delivery Method ======
==== Overview ====
Create a broadcast allowing used Throttle and Delivery Method.
==== URL ====
Http access method: POST
Parameters on the following URL are inside braces { }
{base_url}/rest/api/broadcast/{instanceId}/{shortcode}/{text}/{userName}/{distListId}/{shortcodeIgnore}/{campaignName}/{throttle}/{deliveryMethod}/{date}/{hour}/{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 |
| text | The broadcast content to deliver. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| userName | The user name that will own this broadcast. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] |
| distListId | The Distribution List ID that holds the recipients for this broadcast |
| shortcodeIgnore | A Boolean, if false the shortcode parameter will be ignored |
| campaignName \\ OPTIONAL | The desired campaign name. This parameter must be [[restapi:appx_ciphering|Base64 encoded]] \\ Use **null** to ignore this parameter |
|throttle \\ OPTIONAL | The throttle of the broadcast. **NOTE:** slowest 60 messages per minute, fastest 5400 messages per minute. \\ Use **null** to ignore this parameter |
|deliveryMethod \\ OPTIONAL | The delivery method of the broadcast. The default value is SMS. See our [[restapi:appx_delivery_method|Delivery Method]] section for more information. \\ Use **null** to ignore this parameter |
| date \\ OPTIONAL | The starting time to send this broadcast. \\ A formatted date string: **dd-MM-yyyy** For more information please review the [[restapi:appx_date|pattern letters]] quick reference \\ Use **null** to ignore this parameter |
| hour \\ OPTIONAL | The desired hour to start the broadcast. \\ A formatted date string: **HH:mm** For more information please review the [[restapi:appx_date|pattern letters]] quick reference \\ 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 [[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.
createBroadcast
OKCompleted1Test message2013-09-04T15:15:00-04:002013-09-05T14:45:57-04:002220000000
== 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 |