The following placeholders can be used in the URL template field for SMS submission.
Parameter | Value |
|---|---|
username | Login |
password | Password |
ani | Sender ID |
dnis | Destination address |
text | Message text (URL-encoded) |
textUTF8 | Message text in UTF-8 (non URL-encoded) |
message | Message text (URL-encoded) |
message64 | Message text encoded in base64 |
onewayText | Hex-encoded text in UTF-16 for data coding 8, for other cases - UTF-8 non URL-encoded text |
hexText | Message text in hexadecimal format (applicable to UTF-8) |
hexUCS2 | Message text in hexadecimal format (applicable to UTF-16). For example, the symbol g is encoded as 0067 with the help of the marker |
hexUCS2U | The same as hexUCS2 but with \u prefix. For example, the g symbol is encoded as \u0067 with the help of this marker |
textUTF16BE | Message text in UTF-16 BE format |
serviceType | Service type, provided by the system owner for the registered interconnection. Can be blank. |
ownIntMessageId | Platform-generated message ID (decimal), the maximum length is 10 |
ownHexMessageId | Platform-generated message ID (hexadecimal), the maximum length is 10 |
srcTon, srcNpi, dstTon, dstNpi | TON and NPI for sender ID and destination address respectively. Format: integer. |
dataCoding | Data coding value - 0 or 8. Set as 0 if message can be encoded in GSM7bit, if not then set as 8. |
clientName | Client name (URL-encoded) from which submit_sm has been received (as configured in the Carriers page) |
validityPeriod | Validity period in yyyymmddhh24miss format (in UTC). If not set, the validityPeriod is set as current date + time of delivery reports storing (set in the system setting Delivery waiting period, sec) |
validityPeriodRelative | Validity period in relative format (in seconds) |
silent | Flag that allows sending silent SMS (message that arrives with no sound and is not displayed on the screen) |
localid | Message ID generated for client |
transactionid | Transaction ID |
submitsenttime | Message receive date |
mccmnc | Message MCCMNC |
protocolId | Protocol ID (taken from submit_sm respective field) |
hexUDH | UDH in hexadecimal, if message has no UDH, the marker value left blank |
isconcat | 0/1 flag, set to 1 if submit is a part of a long message |
sarId | UDH message ID in decimal format |
sarIdHex | UDH message ID in hexadecimal format |
sarPartNumber | Segment number |
sarParts | Total number of segments |
im-message | Message text (applicable when a message is sent through IM - instant messaging - provider) |
im_channels | List of IM channels to send a message (a message will be sent thorugh these channels in the specified order) |
im-ttl | TTL for sending of a message through IM channel(s) |
ttl_expiry_text | Message text after expiration of validity period |
image_url | Link to the button image for buttons sent in the message through IM channel(s) |
button_action_url | Link to the website where the user will be redirected after clicking the button (when a message is sent through IM channel(s) |
button_caption | Button caption (when a message is sent through IM channels) |
message_purpose | Applicable when a message is sent through Viber IM channels. Possible values are promotion and transaction |
deliver_only_via_im | Specifies if only IM channels can be used for message sending, proxied from a client submit |
mmsContentUrl | The link obtained from the mmsContentUrl parameter of the incoming submit |
protocolId | Protocol Identifier (same as protocol_id in SMPP) |
NOTE: Starting from 3.5.19 release it is possible to proxy custom markers to HTTP vendors. To configure the feature, contact the Alaris technical support team and communicate the code BZ33127.
NOTE: It is possible to add _noencode and _plencode suffixes (for example, $textUTF8_noencode$) to placeholders in the URL template and _plencode in the POST template of SMS channels. The noencode suffix serves to disable URL encoding; the plencode suffix replaces spaces with '+' while the text is URL encoded (for example, 'Two Factor Auth verification code is: 123456' will be URL encoded as 'Two+Factor+Auth+verification+code+is%3a+123456' if the placeholder $text_plencode$ is used). All text markers except textUTF8 can be set with the _noencode and _plencode suffixes in the URL Template field.