Monday, October 07, 2024
Innovative SMS Gateway & Messaging solutions
asptoken Logo

ASPTOKEN

Programming Notes

ASPTOKEN is supported by the ASPSMS SOAP Web Service since Version 2 ASPSMSX2. The two methods SendTokenSMS and VerifyToken are used.

UserKey
mandatory
Password
mandatory
Originator
If not specified, recipient MSISDN is set.
Recipients
Recipient MSISDN (mandatory) and optional transaction reference number
Usage:
<Recipients>+41790000000:12345</Recipients>
MessageData
If MessageData is set, the placeholder <VERIFICATIONCODE> will be substituted with the verification code. If MessageData is not defined, or if MessageData does not contain the placeholder <VERIFICATIONCODE>, only the verification code is sent.
TokenReference
The token reference is used to distinguish between several tokens for the same phone number.
TokenValidity
Specifies the validity period of a Token in minutes. If not specified, the TokenValidity is 5 minutes by default.
TokenMask
VerificationCode
The verification code can either be generated by mask using TokenMask or explicitly specified using VerificationCode.
  • If the attribute VerifyCode is set, this same verification code will be used.
  • If the attribute VerifyCode is not set, the ASPTOKEN System generates a verification code. Format and construction of the generated verification code can bge specified by mask.
TokenMask
Used to have the ASPSMS generate a verification code by mask. The mask can contain the following special characters:

# : a digit
A : an alphabetic character
N : an alphanumeric character

All other characters are taken literally. If not specified, the Mask is "NNNN" by default.
Usage:
<TokenMask>### ###</TokenMask>
VerificationCode
Explicitly specifies the verification code to be sent to the user.
Usage:
<VerificationCode>qL1x!</VerificationCode>
TokenCaseSensitive
Specifies, if the verification code comparison is case sensitive:
  • 1 : case sensitive
  • 0 : not case sensitive
If not specified, TokenCaseSensitive is 0 by default.
Usage:
<VerificationCode>qL1x!</VerificationCode>
<TokenCaseSensitive>1</TokenCaseSensitive>
URLBufferedMessageNotification

URL that will be connected when a message is not delivered instantly and is buffered. The submitted TransactionReferenceNumber will added to the URL.

When URLBufferedMessageNotification is set to http://www.mysite.com/buffered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this:

http://www.mysite.com/buffered.asp?ID=3152

URLDeliveryNotification

URL that will be connected when a message is delivered instantly. The submitted TransactionReferenceNumber will added to the URL.

When URLDeliveryNotification is set to http://www.mysite.com/delivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this:

http://www.mysite.com/delivered.asp?ID=3152

URLNonDeliveryNotification

URL that will be connected when a message is not delivered. The submitted TransactionReferenceNumber will added to the URL.

When URLBufferedMessageNotification is set to http://www.mysite.com/notdelivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this:

http://www.mysite.com/notdelivered.asp?ID=3152

SendTokenSMS
Send verification code to user.
AffiliateId


VerifyToken
Verification of user input.
UserKey
mandatory
Password
mandatory
PhoneNumber
Specifies the phone number to be verified in combination with a token reference (mandatory).
TokenReference
The token reference is used to distinguish between several tokens for the same phone number (mandatory).
VerificationCode
Specifies the user input to be verified.

To the ASPSMS SOAP Web Service V2 (ASPSMSX2)

New User Registration

Click here for the ASPSMS new user registration.

Have you already registered? Log in with your user e-mail address and password.


Forgot Login Password?

Available SMS tools and interfaces for ASPSMS