smsbox - 1.2.1

3.1 smsbox

Date: 05.04.2005

Table 5-14. SMS Push (send-sms) CGI Variables

`username` (or `user`)	`string`	Username or account name. Must be `username` of the one 'sendsms-user' group in the Kannel configuration, or results in 'Authorization failed' reply.
`password` (or `pass`)	`string`	Password associated with given `username`. Must match corresponding field in the 'sendsms-user' group of the Kannel configuration, or 'Authorization failed' is returned.
`from`	`string`	Phone number of the sender. This field is usually overridden by the SMS Center, or it can be overridden by `faked-sender` variable in the `sendsms-user` group. If this variable is not set, smsbox `global-sender` is used.
`to`	`phone number list`	Phone number of the receiver. To send to multiple receivers, separate each entry with space (' ', '+' url-encoded) - but note that this can be deactivated via `sendsms-chars` in the 'smsbox' group.
`text`	`string`	Contents of the message, URL encoded as necessary. The content can be more than 160 characters, but then `sendsms-user` group must have `max-messages` set more than 1.
`charset`	`string`	Charset of text message. Used to convert to a format suitable for 7 bits or to UCS2. Defaults to ISO-8859-1 if coding is 7bits and UTF16BE if coding is UCS2.
`udh`	`string`	Optional User Data Header (UDH) part of the message. Must be URL encoded.
`smsc`	`string`	Optional virtual smsc-id from which the message is supposed to have arrived. This is used for routing purposes, if any denied or preferred SMS centers are set up in SMS center configuration. This variable can be overridden with a `forced-smsc` configuration variable. Likewise, the `default-smsc` variable can be used to set the SMSC if it is not set otherwise.
`flash`	`number`	Deprecated. See `mclass`.
`mclass`	`number`	Optional. Sets the Message Class in DCS Field. Accepts values between 1 and 4, for Message Class 0 to 3, A value of 1 sends the message directly to display. mclass=2 sends to mobile, 3 do SIM and 4 to SIM Toolkit.
`mwi`	`number`	Optional. Sets Message Waiting Indicator bits in DCS field. If given, the message will be encoded as a Message Waiting Indicator. The accepted values are 1,2,3 and 4 for activating the voice, fax, email and other indicator, or 5,6,7,8 for deactivating, respectivly. This option excludes the `flash` option. [a]
`coding`	`number`	Optional. Sets the coding scheme bits in DCS field. Accepts values 1 to 3, for 7bit, 8bit or UCS2. If unset, defaults to 7 bits unless a udh is defined, which sets coding to 8bits.
`validity`	`number (minutes)`	Optional. If given, kannel will inform SMS Center that it should only try to send the message for this many minutes. If the destination mobile is off other situation that it cannot receive the sms, the smsc discards the message. Note: you must have your kannel box time syncronized with the SMS Center.
`deferred`	`number (minutes)`	Optional. If given, the SMS center will postpone the message to be delivered at now plus this many minutes. Note: you must have your kannel box time syncronized with the SMS Center.
`dlrmask`	`number (bit mask)`	Optional. Request for delivery reports with the state of the sent message. The value is a bit mask composed of: 1: Delivered to phone, 2: Non-Delivered to Phone, 4: Queued on SMSC, 8: Delivered to SMSC, 16: Non-Delivered to SMSC. Must set `dlr-url` on `sendsms-user` group or use the `dlrurl` CGI variable.
`dlrurl`	`string (url)`	Optional. If `dlrmask` is given, this is the url to be fetched. (Must be urlencoded)
`pid`	`byte`	Optional. Sets the PID value. (See ETSI Documentation). Ex: SIM Toolkit messages would use something like `&pid=127&coding=2&alt-dcs=1&mclass=3`
`alt-dcs`	`number`	Optional. If unset, kannel uses the alt-dcs defined on smsc configuration, or 0X per default. If equals to 1, uses FX. If equals to 2, force 0X.
`rpi`	`number`	Optional. Sets the Return Path Indicator (RPI) value. (See ETSI Documentation).
`account`	string	Account name or number to carry forward for billing purposes. This field is logged as ACT in the log file so it allows you to do some accounting on it if your front end uses the same username for all services but wants to distinguish them in the log. In the case of a HTTP SMSC type the account name is prepended with the servicename (username) and a colon (:) and forwarded to the next insta ce of kannel. This allows hierarchical accounting.
Notes: a. To set number of messages, use `mwi=[1-4]&coding=1&udh=%04%01%02%<XX>%<YY>`, where YY are the number of messages, in HEX, and XX are `mwi-1` plus 0xC0 if `text` field is not empty.

Extended headers

Kannel uses and accepts several X-Kannel headers to be used with SMS-services.

Table 5-7. X-Kannel Headers

SMSPush equivalent	X-Kannel Header
`username`	`X-Kannel-Username`
`password`	`X-Kannel-Password`
`from`	`X-Kannel-From`
`to`	`X-Kannel-To`
`text`	request body
`charset`	charset as in `Content-Type: text/html; charset=ISO-8859-1`
`udh`	`X-Kannel-UDH`
`smsc`	`X-Kannel-SMSC`
`flash`	`X-Kannel-Flash` (deprecated, see `X-Kannel-MClass`
`mclass`	`X-Kannel-MClass`
`mwi`	`X-Kannel-MWI`
`coding`	`X-Kannel-Coding`. If unset, defaults to 1 (7 bits) if `Content-Type` is `text/plain` , `text/html` or `text/vnd.wap.wml`. On `application/octet-stream`, defaults to 8 bits (2). All other `Content-Type` values are rejected.
`validity`	`X-Kannel-Validity` (minutes) Optional. If given, kannel will inform SMS Center that it should only try to send the message for this many minutes. If the destination mobile is off other situation that it cannot receive the sms, the smsc discards the message. Note: you must have your kannel box time syncronized with the SMS Center.
`deferred`	`X-Kannel-Deferred` (minutes) Optional. If given, the SMS center will postpone the message to be delivered at now plus this many minutes. Note: you must have your kannel box time syncronized with the SMS Center.
`dlrmask`	`X-Kannel-DLR-Mask`
`dlrurl`	`X-Kannel-DLR-Url`
`account`	`X-Kannel-Account`
`pid`	`X-Kannel-PID`
`alt-dcs`	`X-Kannel-Alt-DCS`

How To Flash SMS

flash (number)

Deprecated. See mclass.

mclass (number)

Optional. Sets the Message Class in DCS Field. Accepts values between 1 and 4, for Message Class 0 to 3, A value of 1 sends the message directly to display. mclass=2 sends to mobile, 3 do SIM and 4 to SIM Toolkit.

mwi (number)

Optional. Sets Message Waiting Indicator bits in DCS field. If given, the message will be encoded as a Message Waiting Indicator. The accepted values are 1,2,3 and 4 for activating the voice, fax, email and other indicator, or 5,6,7,8 for deactivating, respectivly. This option excludes the flash option. [a]

https://127.0.0.1:13002/cgi-bin/sendsms?to=076123457&username=foo&password=bar&text=hello+flash+sms+via+kannel&from=0800505050&mclass=1