Mandatory Parameters
In addition the Global Mandatory Parameters, values for the following parameters must be included:
to: The recipient(s) of this broadcast.
- Each recipient must be in the MSISDN format
- The maximum number of recipients for each broadcast is 10,000.
- Multiple recipients should be seperated with the pipe character.
from: The originator which is being used.
- Applies to the broadcast as a whole.
msg: The actual message(s) which will be read by the mobile user.
- The maximum number of messages within a single broadcast is limited to 10,000.
- Multiple messages must be seperated by the pipe character.
- Pipe characters can be used within individual message bodies, but they must be escaped (i.e. \| ).
- The ratio of messages to recipients can either be one-to-one or one-to-many. That means one message can be sent to (up to) 10,000 recipients or (up to) 10,000 messages can be sent to (up to) 10,00 recipients simultaneously.
- If binary content is being supplied, it must be "hex encoded".
- If a Unicode message is being sent, it must be "utf8 encoded".
- If a plain message needing access to the full GSM charset is being sent, it must be "utf8 encoded".
route: The messaging route which is being used in the broadcast.
- Should either be set to "GD01", "GD02" or "USS1".
- This value applies to the broadcast as a whole.
- Value is not case-sensitive.
subscriptionid: The ID of the subscription service associated with the broadcast.
- This parameter is only mandatory when using the USS1 route.
- This value can be found in the subscription service's brief.
Optional Parameters
Furthermore, values for the following parameters may also be included on an optional basis:
sim: Whether this broadcast is real or just a simulation.
- If set to 'yes', the broadcast will be treated as a simulation.
- Value is not case-sensitive.
custom: Custom data to assist in identifying individual SMS messages.
- The number of custom data must equal the number of recipients otherwise it will be discarded.
- Multiple custom data must be seperated by the pipe character.
- Pipe characters can be used within individual custom data, but they must be escaped (i.e. \| ).
- Each piece of custom data may contain up to 200 alpha-numeric characters.
source: The source of the broadcast to help identify the application through which the broadcast was made.
- Value can consist of alphanumeric characters and basic punctuation.
- Value is not limited in length.
notes: General notes relating to the broadcast.
- Value can consist of alphanumeric characters and basic punctuation.
- Value is not limited in length.
data_type: The type of data being supplied.
- Can either be "plain", "gsm", "unicode" or "binary".
- The default value is "plain".
expiry: The expiry date/time allocated to the SMS.
- Should be in the YYYYMMDDhhmmss format.
- The default value is the maximum period which is "3 days from the date/time of submission".
- If an invalid value is provided, then the default value will be used.
split_method: The manner in which long messages should be split.
- Should be a number between 0 - 8 as follows:
- "0" - No split
- "1" - Simple split (strict)
- "2" - Simple split (graceful)
- "3" - SMS Numbering (strict)
- "4" - SMS Numbering (graceful)
- "5" - Three Dots (strict)
- "6" - Three Dots (graceful)
- "7" - Concatenation (strict)
- "8" - Concatenation (graceful)
- If the data_type of the broadcast is "plain" or "unicode", the default split_method value will be set to "0".
- If the data_type of the broadcast is "binary", the split_method value will be forced to "7" regardless of what split_method value has been supplied.
- If an invalid value is provided, then the default value will be used.