SystorSMS
The following operations are supported. For a formal definition, please review the Service Description.
-
CsvUpload
Upload a csv file with one or more sms using a POST call. Messages with invalid receiver or empty message text will not be sent. Please add the following parameters: sUser Account username. This field is required. String. sPass Account password. This field is required. String. File format: Each line should contain a receiver, an originator and a message. These values should be seperated by a tab character (and not multiple spaces). There should not be more than two tab characters per line. Empty lines will be ignored. (Line endings can be ENTER, \n or \r\n.) receiver The recipient's phone number. originator The SMS originator. If an illegal originator is used, then the system will use an originator registered to your account or 26001 message Only the first 1530 characters of the message text will be sent. Use the character ¤ to create new lines within the message text. Example csv file :
41109511 SystorVest This is the message text¤This part of the text will be placed on a new line 123 SystorVest The receiver is not a valid mobile number. This message will be rejected.The first line will send a sms to mobile number 41109511 with the text "This is the message text". The sender will be SystorVest. The second line does not have a valid receiver and the message will not be sent. Note that the example above uses multiple spaces and not the required tab character. Curl example:curl -X POST "https://smsalert.no/systorsmsvarious/systorsmsvarious.asmx/CsvUpload" -F "data=@sms.csv" -F "sUser=myuser" -F "sPass=mypassword" -H "Content-Type: multipart/form-data" >> "log.txt"Return value for the previous example:File received 2019-05-24T12:49:40Z: sms.csv (Lines with errors are displayed first.) Status: Message not sent Error: Invalid receiver. Receiver: 123 Originator: SystorVest Message: The receiver is not a valid mobile number. This message will be rejected. Status: Message sent Receiver: 41109511 Originator: SystorVest Message: This is the message text.¤This part of the text will be placed on a new line Messages sent: 1 -
FeedbackSms
Send SMS to a predetermined recipient. Please disregard this method unless you have received a key in advance. Parameters: sSM The message sSharedKey Unique key Return value: OK The message was sent Error message Could not send message
-
FrontDirect
For internal use only.
-
GetMessageInfo
Get info for a sent message. Parameters: messageId nForeignId used when sending out the message username Account username password Account password Return value: GetMessageInfoResult: Sent When the message was sent from us to the operator Registered When the message was registered in our database Status: 0 Unsent 1 Sent OK 2 Send Err 3 Cancelled 4 Duplicate Submit Operator's timestamp Notify Timestamp for the last update from the operator NotifyReason Operator specific error code NotifyStatus 0 Delivered 1 Temporary fail 2 Permanent fail ForeignId Customer's unique message identifier Validity The amount of time (in minutes) we'll try to deliver a message before considering it undeliverable SM The message content Cost The cost in norwegian øre for the recipient if it is a CPA message Charged Whether the recipient has been charged null Could not find message
-
GetMessageStatusLast
We recommend using polling only as a last resort, please contact post@systorvest.no to establish asynchronous delivery. Get notify information for a message with ID og ForeignID. Parameters: ID ID of the message (optional) ForeignID ForeignId used when sending out the message (optional) username Account username password Account password Return value: A semicolon separated string with these values: Notify Timestamp for the last update from the operator NotifyReason Operator specific error code NotifyStatus 0 Delivered 1 Temporary fail 2 Permanent fail null Could not find message
-
GetUnreadFromMobile
We recommend using polling only as a last resort, please contact post@systorvest.no to establish asynchronous delivery. Get notify information for a message with ID og ForeignID. Parameters: username Account username password Account password bMarkRead Mark messages as read Return value: A semicolon separated list with these values: Pk Unique identifier Received When the message was received Originator The number who sent the message Message The message null Invalid account info
-
Log
For internal use only.
-
MarkIncomingAsRead
Mark multiple messages as read. Parameters: username Account username password Account password sPKList Comma separated list of Systor message ids Return value: OK Messages was succesfully updated null Could not update messages
-
PostMobileOriginated
For internal use only.
-
PostMobileOriginatedOp
For internal use only.
-
RequestAnswerTicket
Get a unique originator allowing you the trace a response back to a sent message. Parameters: sUser Account username sPass Account password Return value: Returns a unique originator allowing you the trace a response back to a sent message
-
RequestOneTimePassword
Send an sms containing a one time password. @PW in the message will be replaced by a randomly generated one time password e.g. "Your password is @PW." will become "Your password is bqc6743c.". Parameters: sMobileNumber The recipient's phone number or email address sMessage A message for the user containing @PW sOrig The SMS originator. This field is ignored if the recipient is an email address sUser Account username sPass Account password Return value: True SMS or email was successfully sent False Account info or phone number is invalid
-
ReserveGSM
Associate a phone number with an account. Deprecated since 2023: do not rely on this method for receiving SMS any more. Parameters: sUser Account username sPass Account password sGSM The phone number you to associate with the account bFixed Whether the phone number should be locked to the account. Incoming messages will then be sent to this account regardless of the content Return value: True The phone number was successfully associated with the account False Could not associate the phone number with the account
-
SendMessageJson
Send one or more sms. This method returns a sent status for each message. A single line with an error message will be returned if an invalid login or illegal IP is used. Parameters: sJsonData String with json format. {"sUser":"login", "sPass":"passord", "SMS":[{"sFrom":"originator","sRecv":"receiver","sMsg":"message","nForeign":"","nValidity":"","dtHoldUntil":""}]} sUser Account username. This field is required. String. sPass Account password. This field is required. String. SMS (list) sFrom The SMS originator. If an illegal originator is used, then the system will use an originator registered to your account or 26001 sRecv The recipient's phone number. This field is required. sMsg The message. String with max 1530 characters. This field is required. nForeign Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. This field is optional. nValidity Default value is 10080 minutes which means we will try to deliver this sms for a week. Use an empty string or a number between 180 and 10080. This field is optional. dtHoldUntil Time of delivery. Empty string or datetime with format 'yyyy-MM-dd HH:mm' ie '2017-05-23 19:30'. SMS with invalid dates are sent without delay. This field is optional. Return value. String with json. (list) sRecv The recipient's phone number. sFrom The SMS originator. If an illegal originator is used then the system will use an originator registered to your account or 26001 nForeign This is your message id. String with integer above zero. Empty string when not in use. bSent True if the message was sent. See tErrorMessage for details when this value is False. Boolean. tErrorMessage Error message. Empty string if bSent is True. String. Example: {"sUser":"validlogin1", "sPass":"validpassord1", "SMS":[ {"sFrom":"SystorVest","sRecv":"123","sMsg":"testmsg1","nForeign":"2001234"} ,{"sFrom":"SystorVest","sRecv":"+4741109511","sMsg":"testmsg1","nForeign":"2001235","dtHoldUntil":"2018-01-23 19:30"} ,{"sFrom":"SystorVest","sRecv":"47933155","sMsg":"testmsg2"} ]} Return value for the previous example: (Note that 123 is not a valid receiver.) [{"sFrom":"SystorVest","sRecv":"123","nForeign":"2001234","bSent":false,"sErrorMessage":"Invalid receiver. "} ,{"sFrom":"SystorVest","sRecv":"+4741109511","nForeign":"2001235","bSent":true,"sErrorMessage":""} ,{"sFrom":"SystorVest","sRecv":"47933155","nForeign":"","bSent":true,"sErrorMessage":""}]
-
SendMessageToMobile
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileDelay
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sHoldUntil The date and time you want to send the message. Use format "yyyy-MM-dd HH:mm:ss", e.g. 2015-06-05 23:12:37 sOriginator The SMS originator sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileDelayNotify
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sHoldUntil The date and time you want to send the message. Use format "yyyy-MM-dd HH:mm:ss", e.g. 2015-06-05 23:12:37 sOriginator The SMS originator sForeignID Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileEx
Deprecated. Use SendSM.
-
SendMessageToMobileFlashReplace
Send a flash sms message. A Flash SMS is a type of SMS that appears directly on the main screen without user interaction and is not automatically stored in the inbox. It can be useful in emergencies, such as a fire alarm or cases of confidentiality, as in delivering one-time passwords. Parameters: sMobileNumber The recipient's phone number sMessage The message sOriginator The SMS originator sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileNotify
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sOriginator The SMS originator sForeignID Your unique max 200 char alphanumeric message identifier (empty or 0 if not used). The message identifier is used for optional delivery reports. sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileNotifyBulk
Send an sms message to multiple recipients. Parameters: sMobileNumber A comma separated list of the recipients phone numbers sMessage The message sOriginator The SMS originator sForeignID A comma separated list of your unique 32bit message identifiers (set to 0 if not used). The message identifier is used for referencing optional delivery reports. sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileNotifyMVP
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sOriginator The SMS originator nForeignID Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. nValidity The amount of time (in minutes) we'll try to deliver a message before considering it undeliverable sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileNotifyMVPRPID
Send an sms message. Parameters: sMobileNumber The recipient's phone number sMessage The message sOriginator The SMS originator nForeignID Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. nValidity The amount of time (in minutes) we'll try to deliver a message before considering it undeliverable nRPID Relay Protocol-Identifier. Value 65-71 can be used to replace existing messages with the same RPID sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendMessageToMobileWithTicket
Send an sms message with answer ticket allowing you the trace a response back to a sent message. Parameters: sMobileNumber The recipient's phone number sMessage The message sForeignID Your unique max 200 char alphanumeric message identifier (empty or 0 if not used). The message identifier is used for optional delivery reports. sUser Account username sPass Account password Return value: True The message was sent False Could not send message
-
SendSM
Send an sms message. Parameters: sMSISDN The recipient's phone number sSM The message sOriginator The SMS originator nForeignID Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. sUser Account username sPass Account password Return value: Message id of the message
-
SendSmUcs
Send an sms message. UCR Logins can use unicode characters. Parameters: sMSISDN The recipient's phone number sSM The message sOriginator The SMS originator nForeignID Your unique 32bit message identifier (set to 0 if not used). The message identifier is used for referencing optional delivery reports. sUser Account username sPass Account password Return value: Message id of the message
-
VerifyOneTimePassword
Verify a password generated from RequestOneTimePassword. Parameters: sMobileNumber The recipient's phone number or email address sOneTimePW The password to validate sUser Account username sPass Account password Return value: True The password was correct False Account info, the phone number or the one time password is invalid