Property
|
Description
|
Userkey |
Userkey
Example:
SMS.Userkey = "IWHGETG3I" |
Password |
Password
Example:
SMS.Password = "3424iew3" |
PasswordFileLocation |
If you don’t want to place your Username and Passwort directly in the
ASP-Code, you have the possibility to retrieve the information out of a
local file.
Example:
SMS.PasswordfileLocation = "c:/programs/aspsms/mypasswordfile.txt"
The content of the passwordfile has to be specified in the following
format:
Userkey = <Your Userkey>
Password = <Your Password>
Example:
Username = IWHGETG3I
Password = 3424iew3 |
Originator |
Specifies an alphanumeric or nummeric originator.
It can be a mobile phone number or a short text with
a maximum of 11 characters.
Please be aware, that using this feature is delicate.
ANY ABUSES OF THESE NICE FEATURE WILL BE TRACKED AND
PROSECUTED ACCORDING TO SERIOUS CIVIL- AND/OR
CRIMINAL LAW REGULATIONS. We will close such accounts
immediately without prior notification. Thank you for your
understanding.
Example:
SMS.Originator = "aspsms.com"
|
OriginatorUnlockCode
|
Specifies the unlock code sent to a specific originator for authorization.
Usage
SMS.OriginatorUnlockCode = 65164424
|
Credits |
Number of remaining credits, that can be used for sending messages, Read-Only
Example:
Dim lTemp
lTemp = SMS.Credits
|
DeferredDeliveryTime |
If set, specifies when a submitted Message should be sent. The format
is "ddmmyyyyhhmmss". If the component is used outside the timezone GMT+1,
the property "TimeZone" should also be set. |
LifeTime |
If an SMS can not be delivered instantly, it remains within the GSM network for a given time. During this timeframe, the network tries to deliver the SMS periodically. The LifeTime property represents this validity period of an SMS in Minutes. Please note that the LifeTime can not be shorter than 3 minutes and can not exceed 1440 minutes (24h). If not specified, the LifeTime is 24h by default. |
MessageData |
Message that will be sent, can be text or binary hex-coded
Example:
SMS.MessageData = "This is a Textmessage"
SMS.MessageData = "22F81001480E0100000014000000" |
BinaryFileLocation |
Specifies a file, that stores binary-data. For
Logos and Picture-Messages, the format must be *.bmp, for ringtones,
a *.ott or *.txt file has to be specified (*.ott =OTA Tone, *.txt =RTTTL format)
Supported formats:
Operator Logos: Bitmap 72 * 14 Pixel (*.bmp, black/white)
Picture Messages: Bitmap 72 * 28 Pixel (*.bmp, black/white)
Ringtones: The Ringtonefiles have to be compliant to Nokring
or Nokia PC Composer
Example:
SMS.BinaryFileLocation="c:/files/bitmaps/logo17.bmp"
SMS.BinaryFileLocation = "http://www.mysite.com/images/logo17.bmp"
Note: BinaryFileLocation, BinaryFileData and BinaryFileDataHex cannot not be used in combination.
|
BinaryFileData |
Specifies the content of a file which is already in memory in its original format.
Example:
Dim nFileInput As Integer
Dim sFileContent As String
nFileInput = FreeFile
Open sInputFile For Binary As nFileInput
sFileContent = String(FileLen("c:\mypicture.bmp"), " ")
Get nFileInput, , sFileContent
Close
SMS.BinaryFileData = sFileContent
Note: BinaryFileLocation, BinaryFileData and BinaryFileDataHex cannot not be used in combination.
|
BinaryFileDataHex |
Specifies the content of a file which is already in memory in hexadecimal representation.
Example:
Dim nFileInput As Integer
Dim sFileContent As String
nFileInput = FreeFile
Open sInputFile For Binary As nFileInput
sFileContent = String(FileLen("c:\mypicture.bmp"), " ")
Get nFileInput, , sFileContent
Close
SMS.BinaryFileDataHex = sFileContent
Note: BinaryFileLocation, BinaryFileData and BinaryFileDataHex cannot not be used in combination.
|
SMS.WAPPushSettings.Description |
The wap push description describes the content of a wap sms. This property has to be set if using the SendWAPPushSMS action.
Example:
SMS.WAPPushSettings.Description = "Description"
|
SMS.WAPPushSettings.URL |
Specifies the url of the file to be transferred by wap protocol. This property has to be set if using the SendWAPPushSMS action.
Example:
SMS.WAPPushSettings.URL = "http://www...."
|
FlashingSMS |
If set to "True", a text-message will displayed directly in the display
of the recipient
Example:
SMS.FlashingSMS = true |
BlinkingSMS |
If set to "True", the text-message or parts of
it will blink, when the message is displayed on the mobilephone. If used, the total
number of used characters is limited to 69 characters. Note: In the
moment, this features works only on the Nokia phones Nokia 3210, 3310, 5110,
6110, 6150, 8210, 8810, 8850. With the command<BLINK>, used in the messagetext, it’s
possible to control the appearance of the blinking the text. This
feature works in conjunction with the methods “SendTextSMS”, “SendVCard” and “SendMessageWaitingIndication”.
Example 1, complete message is blinking:
SMS.BlinkingSMS = true
SMS.MessageData = ""
Example 2, Message "I love you!", but only the word "love" is blinking
SMS.BlinkingSMS = true
SMS.MessageData = "I <BLINK> </BLINK> you!" |
ReplaceMessage |
If set to a value ranging from 1 to 7, this allows to
overwrite existing messages on a handset with the same ReplaceMessage value.
Example:
SMS.ReplaceMessage = 5 |
Special information: MCC and MNC
The Mobile-Country-Code and the Mobile-Network-Code should be specified when sending operator-logos. If
these parameters are not set, our system tries to evaluate these parameters with the Recipient-Address. See
also example and providerlist.
To delete an existing logo from a mobilephone, set both MCC and MNC to -1. After having received and saved
a logo sent with this parameters, the logo disappears and the mobilephone is set back to its original state
without logo.
|
MCC |
Mobile-Country-Code, should be specified when sending operator-logos
Example:
SMS.MCC = 228 |
MNC |
Mobile-Network-Code, should be specified when sending operator-logos
SMS.MNC = 1 |
URLBufferedMessageNotification |
URL that will be connected when a message is not delivered instantly
and is buffered. The value of the submitted TransactionReferenceNumber
will be the argument of the URL
Example:
SMS.URLBufferedMessageNotification = "http://www.mysite.com/sms/buffered.asp?ID="
When the TransactionReferenceNumber is e.g. 3152, the URL will be loaded like this:
http://www.mysite.com/sms/buffered.asp?ID=3152
Cost: FREE |
URLDeliveryNotification |
URL that will be connected when a message is delivered instantly.The
value of the submitted TransactionReferenceNumber will be the argument
of the URL
Example:
SMS.URLDeliveryNotification = "http://www.mysite.com/sms/delivered.asp?ID="
When the TransactionReferenceNumber is e.g. 3152, the URL will be loaded
like this:
http://www.mysite.com/sms/delivered.asp?ID=3152
Cost: FREE |
URLNonDeliveryNotification |
URL that will be connected when a message is not delivered. The value
of the submitted TransactionReferenceNumber will be the argument of the
URL
Example:
SMS.URLNonDeliveryNotification = "http://www.mysite.com/sms/notdelivered.asp?ID="
When the TransactionReferenceNumber is e.g. 3152, the URL will be loaded
like this:
http://www.mysite.com/sms/notdelivered.asp?ID=3152
Cost: FREE |
Special information: URL properties
The following instructions do extend the functionality
of the URL properties in very powerful way.
The URL properties may be used like described below:
URLBufferedMessageNotification =
|
"http://www.yourhost.com/Buffered.asp?SCTS=<SCTS>" &_
"&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>"
|
URLDeliveryNotification =
|
"http://www.yourhost.com/Delivered.asp?SCTS=<SCTS>" &_
"&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>"
|
URLNonDeliveryNotification =
|
"http://www.yourhost.com/NotDelivered.asp?SCTS=<SCTS>" &_
"&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>"
|
The corresponding URLs are loaded by ASPSMS, if the relevant
events occur.
The following tags are placeholders and are being filled
with values when loaded.
- <RCPNT> (Recipient, Mobilenumber)
- <SCTS> (Servicecenter Timestamp, Submissiondate)
- <DSCTS> (Delivery Servicecenter Timestamp, Notificationdate)
- <RSN> (Reasoncode)
- <DST> (Deliverystatus)
- <TRN> (Transactionreferencenummer)
- <CREDITS> (Used credits)
The tags within the definition of the URL may be placed on any position, the
lenght of one URL is limited to 200 chars.
One URL, which may be called ASPSMS, could look like the following:
http://www.yourhost.com/Buffered.asp?SCTS=25062002120236&DSCTS=25062002120241&RSN=107&DST=1&TRN=00001
Explanation:
Submissiondate: 25.06.2002 12:02:36
Notificationdate: 25.06.2002 12:02:41
Reasoncode: 107 (Absent Subscriber)
Deliverystatus: 1 (Buffered)
Transactionreferencenumber: 00001
Please note also that after Deliverystatus 1 (Buffered) nearly always
the URL is called a secondtime with Deliverystatus 0 (Delivered, Good)
or Deliverystatus 2 (Not delivered, Bad).
Cost: Specifying the URL properties is for free.
|
TimeZone |
Specifies the Timezone where the component is used. It’s only necessary
to set this property when the property DeferredDeliveryTime is used and
the component is used outside the timezone GMT +1.
Example:
SMS.TimeZone = "0" |
TimeOut |
Specifies the ammount of seconds, after a connectiontry times
out and the component will be unloaded automatically with returning an
errorcode.
Example:
SMS.TimeOut = 30 |
XSer |
Additional information for binary messages, only used when sending
directly to the SMSC gateway. Check examples and UCP specification for
additional information
Example:
SMS.XSer = "010706050415821582" |
NotificationInquirySettings.Format |
Specifies the format of the returned result of the method
InquireDeliveryNotifications.
The datevalues of Submissiondate and Notificationdate are in the
format "ddmmyyyyhhmmss".
Possible values: Format 0 (default) Complete information
with Carriage Return (Asciicodes 13 and 10) at the Lineend
TransactionReferenceNumber<Separator>
DeliveryStatus<Separator>
SubmissionDate<Separator>
NotificationDate<Separator>
Reasoncode<Carriage Return>
Example of a Result in this
format: 1234567890<Separator>1<Separator>22052001213354<Separator>
2205201213401<Separator>107<Carriage Return>
Format 1 Complete information with userdefined separator at
the Lineend TransactionReferenceNumber<Separator>
DeliveryStatus<Separator>
SubmissionDate<Separator>
NotificationDate<Separator>
Reasoncode<Separator>
Example of a Result in this
format: 1234567890<Separator>1<Separator>22052001213354<Separator>
220501213401<Separator>107<Separator>
Format 2 Simple information with Carriage Return (Asciicodes
13 and 10) at the
Lineend TransactionReferenceNumber<Separator> DeliveryStatus<Carriage
Return>
Example of a Result in this
format: TransactionReferenceNumber<Separator>
DeliveryStatus<Carriage Return>
Format 3 Simple information with userdefined separator at the
Lineend TransactionReferenceNumber<Separator>
DeliveryStatus<Separator>
Example of a Result in this
format: TransactionReferenceNumber<Separator>
DeliveryStatus<Separator>
Example: SMS.NotificationInquirySettings.Format = 0 |
NotificationInquirySettings.Separator |
Specificies a user defined separator which will be part
of the result of the method InquireDeliveryNotifications. Default value is the Tabulatorsign (Asciicode
9)
Example: SMS.NotificationInquirySettings.Separator =
";" |
VCard.Name |
Specifies the Name
that will show up in a phonebook entry.
Example: SMS.VCard.Name =
“Sandra” |
VCard.PhoneNumber |
Specifies the
Phonenumber that will used in a phonebook entry
Example: SMS.VCard.Phonenumber =
“+417912345678” |
MessageWaitingIndicationSettings. VoiceIndication |
Specifies if a mobilephone will be notified about pending
voicemessages.
Example: SMS. MessageWaitingIndicationSettings.VoiceIndication
= True |
MessageWaitingIndicationSettings. CountVoiceMessages |
Specifies the
number of pending voicemessages. Use the value “0” to delete the
indicationsymbol on a mobilephone.
Example:
SMS.MessageWaitingIndicationSettings.CountVoiceMessages =
255 |
MessageWaitingIndicationSettings. FaxIndication |
Specifies if a mobilephone will be notified
about pending faxmessages.
Example: SMS.MessageWaitingIndicationSettings.FaxIndication =
False |
MessageWaitingIndicationSettings. CountFaxMessages |
Specifies the
number of pending faxmessages. Use the value “0” to delete the
indicationsymbol on a mobilephone.
Example: SMS.MessageWaitingIndicationSettings.CountFaxMessages
= 10 |
MessageWaitingIndicationSettings. EmailIndication |
Specifies if a
mobilephone will be notified about pending Emailmessages.
Example: SMS.MessageWaitingIndicationSettings.EmailIndication
= True |
MessageWaitingIndicationSettings. CountEmailMessages |
Specifies the
number of pending EMailmessages. Use the value “0” to delete the
indicationsymbol on a mobilephone.
Example: SMS.MessageWaitingIndicationSettings.CountEmailMessages
= 0 |
MessageWaitingIndicationSettings. OtherIndication |
Specifies if a
mobilephone will be notified about other pending messages.
Example: SMS.MessageWaitingIndicationSettings.OtherIndication
= True |
MessageWaitingIndicationSettings. CountOtherMessages |
Specifies the
number of other pending messages. Use the value “0” to delete the
indicationsymbol on a mobilephone.
Example: SMS.MessageWaitingIndicationSettings.CountOtherMessages
= 5 |
MessageWaitingIndicationSettings. StoreMessage |
Specifies, if a
sent Message Waiting Indication Message can be stored in the
mobilephone or not.
Example: MessageWaitingIndicationSettings.StoreMessage =
false |
AffiliateId |
If you are registered as an affiliate model 1 member you can send the corresponding affiliate id.
More information about the affiliate program is available at https://www.aspsms.com/en/affiliates/.
Example:
SMS.AffiliateId = 000000
|
ErrorCode |
After invoking a method the property ErrorCode holds a value, related
to the last operation. If the operation was successful, ErrorCode is 1.
If there was an error, the value is different from 1
Example:
SMS.SendRandomLogo
If SMS.Errorcode = 1 then
Msgbox "Logo successfully sent"
else
Msgbox SMS.ErrorDescription
End if |
ErrorDescription |
The property ErrorDescription gives specific information, why an error
has occured.
Example: Msgbox SMS.ErrorDescription |