CheckCredits | |
Description: | Check your ASPSMS credits. Buy ASPSMS credits. |
HTTP-POST URL: | http://json.aspsms.com/CheckCredits |
JSON Request Object: | { "UserName": "", "Password": "" } |
Parameter Info: |
|
JSON Response Object: | { "Credits": "", "StatusCode": "", "StatusInfo": "" } |
Example Client: | <!-- >ASPSMS JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>ASPSMS JSON API - Javascript Example (CheckCredits)</title> <style> </style> </head> <body> <p>JSONSMS - Example</p> <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.aspsms.com/CheckCredits", type: 'POST', dataType : "json", data: JSON.stringify({'UserName':'userkey','Password':'secret'}), success:function(data){ console.log(data);}, error: function() {console.log(data); } } ); }); </script> </body> </html> |
SendTextSMS | |
Description: | Send single or multipart text messages in GSM 7-bit or Unicode. |
HTTP-POST URL: | http://json.aspsms.com/SendTextSMS |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "", "Recipients": [ "" ], "MessageText": "", "DeferredDeliveryTime": "", "FlashingSMS": "", "URLBufferedMessageNotification": "", "URLDeliveryNotification": "", "URLNonDeliveryNotification": "", "AffiliateID": "", "ForceGSM7bit": true } |
Parameter Info: |
|
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. <RCPNT> (Recipient, Mobilenumber) <SCTSUTC> (Servicecenter Timestamp, Submissiondate in ISO 8601 UTC) <DSCTSUTC> (Delivery Servicecenter Timestamp, Notificationdate in ISO 8601 UTC) <SCTSCET> (Servicecenter Timestamp, SubmissiondateISO 8601 CET) <DSCTSCET> (Delivery Servicecenter Timestamp, Notificationdate in ISO 8601 CET) <SCTS> (Servicecenter Timestamp, Submissiondate in ddmmyyyyhhmmss) <DSCTS> (Delivery Servicecenter Timestamp, Notificationdate in ddmmyyyyhhmmss) <RSN> (Reasoncode) <DST> (Deliverystatus) <TRN> (Transactionreferencenummer) Example: http://yoursite.com/ReceiveNotification?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&DSCTSUTC=<DSCTSUTC>&SCTSUTC=<SCTSUTC> The tags within the definition of the URL may be placed on any position, the length of one URL is limited to 200 chars. It's possible to use the same path for all three URL...Notification parameters. |
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
Example Client: | <!-- >ASPSMS JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>ASPSMS JSON API - Javascript Example (SendTextSMS)</title> </head> <body> <p>JSONSMS - Example</p> <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.aspsms.com/SendTextSMS", type: 'POST', dataType : "json", data: JSON.stringify({'UserName':'username','Password':'password',"Originator":"+4176000000","Recipients":["+4170000000:76532","+4170000001:HT763t"],"MessageText":"hello from jsonsms"}), success:function(data){ console.log(data);}, error: function() {console.log(data); } } ); }); </script> </body> </html> |
SendSimpleTextSMS | |
Description: | Send single or multipart text messages in GSM 7-bit or Unicode. |
HTTP-POST URL: | http://json.aspsms.com/SendSimpleTextSMS |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "", "Recipients": "", "MessageText": "", "ForceGSM7bit": true } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
Example Client: | <!-- >ASPSMS JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>ASPSMS JSON API - Javascript Example (SendTextSMS)</title> </head> <body> <p>JSONSMS - Example</p> <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.aspsms.com/SendTextSMS", type: 'POST', dataType : "json", data: JSON.stringify({'UserName':'username','Password':'password',"Originator":"+4176000000","Recipients":["+4170000000:76532","+4170000001:HT763t"],"MessageText":"hello from jsonsms"}), success:function(data){ console.log(data);}, error: function() {console.log(data); } } ); }); </script> </body> </html> |
InquireDeliveryNotifications | |
Description: | Inquire Delivery Notifications. |
HTTP-POST URL: | http://json.aspsms.com/InquireDeliveryNotifications |
JSON Request Object: | { "UserName": "", "Password": "", "TransactionReferenceNumbers": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "", "DeliveryNotifications": [ { "TransactionReferenceNumber": "", "DeliveryStatus": "", "DeliveryStatusDescription": "", "SubmissionDate": "", "NotificationDate": "", "Reasoncode": "", "ReasoncodeDescription": "" } ] } |
SendOriginatorUnlockCode | |
Description: | The ASPSMS System creates a random OriginatorUnlockCode and sends it to the specified originator to be unlocked. |
HTTP-POST URL: | http://json.aspsms.com/SendOriginatorUnlockCode |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
UnlockOriginator | |
Description: | Unlocks a originator with a originator unlock code |
HTTP-POST URL: | http://json.aspsms.com/UnlockOriginator |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "", "UnlockCode": "", "AffiliateID": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
CheckOriginatorAuthorization | |
Description: | Verifies if a specific numeric originator is authorized for your account. |
HTTP-POST URL: | http://json.aspsms.com/CheckOriginatorAuthorization |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
SendTokenSMS | |
Description: | Send verification code to user. |
HTTP-POST URL: | http://json.aspsms.com/SendTokenSMS |
JSON Request Object: | { "UserName": "", "Password": "", "Originator": "", "Recipients": "", "MessageData": "", "TokenReference": "", "TokenValidity": "", "TokenMask": "", "VerificationCode": "", "TokenCaseSensitive": "", "URLBufferedMessageNotification": "", "URLDeliveryNotification": "", "URLNonDeliveryNotification": "", "AffiliateID": "" } |
Parameter Info: |
|
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. <RCPNT> (Recipient, Mobilenumber) <SCTSUTC> (Servicecenter Timestamp, Submissiondate in ISO 8601 UTC) <DSCTSUTC> (Delivery Servicecenter Timestamp, Notificationdate in ISO 8601 UTC) <SCTSCET> (Servicecenter Timestamp, SubmissiondateISO 8601 CET) <DSCTSCET> (Delivery Servicecenter Timestamp, Notificationdate in ISO 8601 CET) <SCTS> (Servicecenter Timestamp, Submissiondate in ddmmyyyyhhmmss) <DSCTS> (Delivery Servicecenter Timestamp, Notificationdate in ddmmyyyyhhmmss) <RSN> (Reasoncode) <DST> (Deliverystatus) <TRN> (Transactionreferencenummer) Example: http://yoursite.com/ReceiveNotification?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&DSCTSUTC=<DSCTSUTC>&SCTSUTC=<SCTSUTC> The tags within the definition of the URL may be placed on any position, the length of one URL is limited to 200 chars. It's possible to use the same path for all three URL...Notification parameters. |
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
VerifyToken | |
Description: | Verification of user input. |
HTTP-POST URL: | http://json.aspsms.com/VerifyToken |
JSON Request Object: | { "UserName": "", "Password": "", "PhoneNumber": "", "TokenReference": "", "VerificationCode": "" } |
Parameter Info: |
|
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. |
HTTP-POST URL: | http://json.aspsms.com/CreateVoucher |
JSON Request Object: | { "UserName": "", "Password": "", "NumberOfVouchers": "", "AmountCreditsPerVoucher": "", "Remarks": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
GetVoucherTransactions | |
Description: | List all vouchers you have created and/or redeemed. Creation date and remarks are only visible for own vouchers. |
HTTP-POST URL: | http://json.aspsms.com/GetVoucherTransactions |
JSON Request Object: | { "UserName": "", "Password": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "", "vouchers": [ "" ] } |
RedeemVoucher | |
Description: | The amount of ASPSMS credits of the redeemed voucher are added to your ASPSMS account volume. |
HTTP-POST URL: | http://json.aspsms.com/RedeemVoucher |
JSON Request Object: | { "UserName": "", "Password": "", "RedeemCode": "" } |
Parameter Info: |
|
JSON Response Object: | { "StatusCode": "", "StatusInfo": "" } |
VersionInfo | |
Description: | Get the current version of the API |
HTTP-POST URL: | http://json.aspsms.com/VersionInfo |
JSON Request Object: | {} |
Parameter Info: | |
JSON Response Object: | {} |
ListAllStatusCodes | |
Description: | Lists all possible Status Codes returned by the API |
HTTP-POST URL: | http://json.aspsms.com/ListAllStatusCodes |
JSON Request Object: | {} |
Parameter Info: | |
JSON Response Object: | {} |