This is the RESTful ASPSMS JSON API to connect to the ASPSMS System. From Two-Factor Authentication ASPTOKEN to Bulk SMS, anything you can possibly think of can be implemented with the ASPSMS JSON interface. All features are supported, such as ASPTOKEN, request remaining credits, delivery notification and a lot more.

Password: Your ASPSMS Password. To retrieve your lost Password use this link.

Originator: You can use a phone number or up to 11 Alphabetic characters (e.g. 'MYBUSINESS') as Originator. In order to use a phone number (e.g. '+4176000000') you must unlock it first using the UnlockOriginator method.

Recipients: Add Recipients as JSON Array ["number1:transaction-id1","number2:transaction-id3", ... ] (e.g. ["+4170000000:76532","+4170000001:HT763t", ...]. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code] (eg. '+41780000000'). The Transaction-ID is not mandatory, it's used as reference in the delivery notifications. The maximum number of recipients per request is 1000.

DeferredDeliveryTime: By setting the deferred delivery time you can schedule jobs to execute at a specific time. The date time format accepted is ISO8601 UTC YYYY-MM-DDThh:mm:ssTZD (e.g.'2018-08-31T14:00:07+02:00') http://www.w3.org/TR/NOTE-datetime.

FlashingSMS: The message appears directly on the screen of the mobile phone. A flashing message isn't saved directly on the mobile phone. The recipient has to choose to save it. Otherwise the message irrevocably disappears from the screen.

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

Example:
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 called when a message is delivered instantly. The submitted TransactionReferenceNumber will added to the URL.

Example:
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.

Example:
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

AffiliateID: If you are a affiliate partner with ASPSMS you can provide your affiliate-id here.

Notification URL properties:

If a more detailed delivery notification is required, the following tags can be used within the URLDeliveryNotification, URLNonDeliveryNotification and URLBufferedMessageNotification parameters. These are then being replaced with actual values when the notification URL is requested.

Password: Your ASPSMS Password. To retrieve your lost Password use this link.

Originator: You can use a phone number or up to 11 Alphabetic characters (e.g. 'MYBUSINESS') as Originator. In order to use a phone number (e.g. '+4176000000') you must unlock it first using the UnlockOriginator method.

Recipients: Add Recipients as JSON Array ["number1:transaction-id1","number2:transaction-id3", ... ] (e.g. ["+4170000000:76532","+4170000001:HT763t", ...]. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code] (eg. '+41780000000'). The Transaction-ID is not mandatory, it's used as reference in the delivery notifications. The maximum number of recipients per request is 1000.

Password: Your ASPSMS Password. To retrieve your lost Password use this link.

Originator: You can use a phone number or up to 11 Alphabetic characters (e.g. 'MYBUSINESS') as Originator. In order to use a phone number (e.g. '+4176000000') you must unlock it first using the UnlockOriginator method.

Recipients: Add Recipients as JSON Array ["number1:transaction-id1","number2:transaction-id3", ... ] (e.g. ["+4170000000:76532","+4170000001:HT763t", ...]. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code] (eg. '+41780000000'). The Transaction-ID is not mandatory, it's used as reference in the delivery notifications. The maximum number of recipients per request is 1000.

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: The verification code can either be generated by mask using TokenMask or explicitly specified using VerificationCode.

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:

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

Example:
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 called when a message is delivered instantly. The submitted TransactionReferenceNumber will added to the URL.

Example:
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.

Example:
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

AffiliateID: If you are a affiliate partner with ASPSMS you can provide your affiliate-id here.

Notification URL properties:

If a more detailed delivery notification is required, the following tags can be used within the URLDeliveryNotification, URLNonDeliveryNotification and URLBufferedMessageNotification parameters. These are then being replaced with actual values when the notification URL is requested.

Password: Your ASPSMS Password. To retrieve your lost Password use this link.

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.

VerificationCode: Specifies the user input to be verified.

JSON Response Object:

{
"StatusCode": "",
"StatusInfo": ""
}

CreateVoucher

Description:

If you easily want to give credits to another ASPSMS user, you can generate voucher codes. Voucher codes have no expiration date and can also be redeemed by yourself. Like this, you have a built-in money-back guarantee.