server2sms JSON API - Service Description

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

CheckCredits
Description:	Check your server2sms credits. Buy server2sms credits.
HTTP-POST URL:	https://json.server2sms.com/CheckCredits
JSON Request Object:	{ "UserName": "", "Password": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link.
JSON Response Object:	{ "Credits": "", "StatusCode": "", "StatusInfo": "" }
Example Client:	<!-- >server2sms JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>server2sms JSON API - Javascript Example (CheckCredits)</title> <style> </style> </head> <body> <p>JSONSMS - Example</p> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.server2sms.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:	https://json.server2sms.com/SendTextSMS
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "", "Recipients": [ "" ], "MessageText": "", "DeferredDeliveryTime": "", "FlashingSMS": "", "URLBufferedMessageNotification": "", "URLDeliveryNotification": "", "URLNonDeliveryNotification": "", "AffiliateID": "", "ForceGSM7bit": true }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms 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. MessageText: The message text property accepts UTF8 encoding. Long messages get concatenated automatically. Encoding is detected automatically. If Unicode Characters are used the maximum multipart message length is 603 Characters = 9 concatenated messages. For GSM 7-bit the maximum multipart message length is 1377 = 9 concatenated messages. 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') https://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 https://www.mysite.com/buffered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://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 https://www.mysite.com/delivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://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 https://www.mysite.com/notdelivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://www.mysite.com/notdelivered.asp?ID=3152 AffiliateID: If you are a affiliate partner with server2sms you can provide your affiliate-id here. ForceGSM7bit: Force sending GSM7bit characters only to avoid extra cost by acidentally using Unicode Characters
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: https://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:	<!-- >server2sms JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>server2sms JSON API - Javascript Example (SendTextSMS)</title> </head> <body> <p>JSONSMS - Example</p> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.server2sms.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:	https://json.server2sms.com/SendSimpleTextSMS
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "", "Recipients": "", "MessageText": "", "ForceGSM7bit": true }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms 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. MessageText: The message text property accepts UTF8 encoding. Long messages get concatenated automatically. Encoding is detected automatically. If Unicode Characters are used the maximum multipart message length is 603 Characters = 9 concatenated messages. For GSM 7-bit the maximum multipart message length is 1377 = 9 concatenated messages. ForceGSM7bit: Force sending GSM7bit characters only to avoid extra cost by acidentally using Unicode Characters
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "" }
Example Client:	<!-- >server2sms JSON API - Javascript Example (SendTextSMS) --> <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>server2sms JSON API - Javascript Example (SendTextSMS)</title> </head> <body> <p>JSONSMS - Example</p> <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script> <script> $(document).ready(function() { $.ajax( { url : "https://json.server2sms.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:	https://json.server2sms.com/InquireDeliveryNotifications
JSON Request Object:	{ "UserName": "", "Password": "", "TransactionReferenceNumbers": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. TransactionReferenceNumbers: TransactionReferenceNumbers delimited by ;
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "", "DeliveryNotifications": [ { "TransactionReferenceNumber": "", "DeliveryStatus": "", "DeliveryStatusDescription": "", "SubmissionDate": "", "NotificationDate": "", "Reasoncode": "", "ReasoncodeDescription": "" } ] }

SendOriginatorUnlockCode
Description:	The server2sms System creates a random OriginatorUnlockCode and sends it to the specified originator to be unlocked.
HTTP-POST URL:	https://json.server2sms.com/SendOriginatorUnlockCode
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. Originator_Unlock: The phone number to unlock as originator. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code]
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "" }

UnlockOriginator
Description:	Unlocks a originator with a originator unlock code
HTTP-POST URL:	https://json.server2sms.com/UnlockOriginator
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "", "UnlockCode": "", "AffiliateID": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. Originator_Unlock: The phone number to unlock as originator. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code] UnlockCode: The originator unlock code you have received. AffiliateID: If you are a affiliate partner with server2sms you can provide your affiliate-id here.
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "" }

CheckOriginatorAuthorization
Description:	Verifies if a specific numeric originator is authorized for your account.
HTTP-POST URL:	https://json.server2sms.com/CheckOriginatorAuthorization
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. Originator_Unlock: The phone number to unlock as originator. We recommend E.164 phone number formatting: [+][country code][subscriber number including area code]
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "" }

SendTokenSMS
Description:	Send verification code to user.
HTTP-POST URL:	https://json.server2sms.com/SendTokenSMS
JSON Request Object:	{ "UserName": "", "Password": "", "Originator": "", "Recipients": "", "MessageData": "", "TokenReference": "", "TokenValidity": "", "TokenMask": "", "VerificationCode": "", "TokenCaseSensitive": "", "URLBufferedMessageNotification": "", "URLDeliveryNotification": "", "URLNonDeliveryNotification": "", "AffiliateID": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms 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 server2sms 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. Example: When URLBufferedMessageNotification is set to https://www.mysite.com/buffered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://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 https://www.mysite.com/delivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://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 https://www.mysite.com/notdelivered.asp?ID= and the TransactionReferenceNumber is e.g. 3152, the URL will be requested like this: https://www.mysite.com/notdelivered.asp?ID=3152 AffiliateID: If you are a affiliate partner with server2sms 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. <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: https://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:	https://json.server2sms.com/VerifyToken
JSON Request Object:	{ "UserName": "", "Password": "", "PhoneNumber": "", "TokenReference": "", "VerificationCode": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms 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 server2sms 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:	https://json.server2sms.com/CreateVoucher
JSON Request Object:	{ "UserName": "", "Password": "", "NumberOfVouchers": "", "AmountCreditsPerVoucher": "", "Remarks": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. NumberOfVouchers: Number of vouchers to create. AmountCreditsPerVoucher: Specify the amount of server2sms credits per voucher to be created. Remarks: Internal remarks for the voucher(s) to be created.
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:	https://json.server2sms.com/GetVoucherTransactions
JSON Request Object:	{ "UserName": "", "Password": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link.
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "", "vouchers": [ "" ] }

RedeemVoucher
Description:	The amount of server2sms credits of the redeemed voucher are added to your server2sms account volume.
HTTP-POST URL:	https://json.server2sms.com/RedeemVoucher
JSON Request Object:	{ "UserName": "", "Password": "", "RedeemCode": "" }
Parameter Info:	UserName: Your server2sms Userkey. Password: Your server2sms Password. To retrieve your lost Password use this link. RedeemCode: Unique voucher code. The server2sms system verifies if there is a voucher with the corresponding voucher code.
JSON Response Object:	{ "StatusCode": "", "StatusInfo": "" }

VersionInfo
Description: Get the current version of the API
HTTP-POST URL: https://json.server2sms.com/VersionInfo
JSON Request Object: {}
Parameter Info:
JSON Response Object: {}

ListAllStatusCodes
Description:	Lists all possible Status Codes returned by the API
HTTP-POST URL:	https://json.server2sms.com/ListAllStatusCodes
JSON Request Object:	{}
Parameter Info:
JSON Response Object:	{}

VersionInfo
Description:	Get the current version of the API
HTTP-POST URL:	https://json.server2sms.com/VersionInfo
JSON Request Object:	{}
Parameter Info:
JSON Response Object:	{}