The SMS Broadcast Service supports a number of parameters. ‘Phone_number’ is the only required parameter in the Broadcast file. ‘Message’ may uploaded in the Broadcast file for entered in the UI. Optional parameters allow for configuration of future send times, personalized messages (using templates and variables), and meta-data (used for message/contact tracking).
| No. | Column | Required | Format | Description |
|---|---|---|---|---|
| 01 | Phone_number | Yes | 10 – 15-digit number | Destination phone number with country code (e.g. 16175551212 for a USA number) |
| 02 | Message | No | string | Message to be sent to the mobile phone. Messages can be added to the Broadcast file or entered in the UI. To accommodate special characters, double (non-shaped) quotes are highly recommended. |
| 03 | Date_time | Optional | MM-DD-YYYY: HH:mm M-D-YY: HH:mm HH:MM |
Message send time. If blank, broadcast will start immediately. If MM-DD-YYYY is missing, current date will be used. Time is in 24-hour format. |
| 04 | Source_number | Optional | 5 – 15 digit number | The transport code that ‘sends’ the message |
| 05 | Throughput | Optional | 1, 10, 100, 1000 | The speed (in messages per minute) at which the entire file is sent. May only be used as a default parameter (the throughput number applies to the entire file) |
| 06 | Param1 Param2 … |
Optional | string | Parameters are values inserted in template messages. The default parameter message is used as the template, the strings specified as parameters are then inserted. See Template Messages section for more info. |
| 06 | Agent_id | Optional | number or string (e.g. ABC123) | Optional parameter for integration with call center platforms. If present, the value will be associated with inbound traffic for this mobile number. |
| 07 | User_id | Optional | number or string (e.g. ABC123) | Optional parameter for integration with call center platforms. If present, the value will be associated with inbound traffic for this mobile number. |
| 08 | Template | Optional | string | Optional parameter for using pre-defines templates instead of a message copy. Is used INSTEAD of Message |
| 09 | Meta_data1 | Optional | number or string (e.g. ABC123) | Optional non-messaging related parameter for linking external data to a specific message, especially useful for reporting purposes |
Phone_number (required): The destination phone number with country code (e.g. 16175551212).
Message: The message to send. If only the first message is specified, it will be the default for all other messages. If there are special characters in the message (#,@,$,%, etc.), the message must be formatted within double quotes (non-shaped). See Appendix A for details on message lengths, encoding, and concatenation.
Date_time: If the date_time parameter is missing, the message will be sent immediately. Format for date_time is MM-DD-YYYY: hh:mm.
Source_number: For accounts the multiple source numbers (the ‘From’ number when sending a message), a specific source number may be designated with this parameter. Only numbers that have been assigned to an account may be used.
Throughput: Messages per minute that the broadcast file will be sent. When messages include a call-to-action (e.g._ “call or text now…”_), customer service managers often prefer to send messages at a slower rate to spread out call center traffic. Throughput may be set either in the UI or in the broadcast file.
Param1, Param2,…: User-defined parameters inserted in message templates for personalized SMS messages. Up to ten (10) different user-defined parameters can be used. Refer to Message Template section for more information.
Agent_id and User_id: Tracking information that is logged with individual outbound messages. This information is used by call center and CRM systems for routing and tracking purposes.
Template: Template is an optional parameter that replaces Message. Templates can be generated and modified in the UI and used instead of the message copy. By using templates, the message will be the same for all subscribers in your broadcast (with the exception of the dynamic parameters you specify as placeholders). If you’re using a broadcast file and want to use templates, the template must already exist in the UI.
Meta_data1: Similar to Agent_id, Meta_data1 is a more generic optional parameter to link external information to specific messages. The most common use case is adding subscriber specific information to outbound messages to link messages back to reporting data. Meta_data1 information is also useful for integrations with external systems (CRM systems, contact center platforms, etc.).