Moursel
| API | Description |
|---|---|
| https://api.moursel.com/api/Moursel/ClientLogIn?userName={userName}&passWord={passWord} |
ClientLogIn Logs in and creates a session return values: [>0, ''] = Success. It returns the Session Id (to be Used Later in other methods) [-1, ''] = Invalid username and password [-2, ''] = Inactive user [-3, ''] = Server Error |
| https://api.moursel.com/api/Moursel/CreateSubUser?LogId={LogId}&UserFName={UserFName}&UserLName={UserLName}&UserMobile={UserMobile}&UserPhone={UserPhone}&UserFax={UserFax}&UserCompany={UserCompany}&UserArea={UserArea}&UserCity={UserCity}&UserAdress={UserAdress}&UserPOBox={UserPOBox}&UserUName={UserUName}&UserPassword={UserPassword}&SenderId={SenderId}&UserBirthDay={UserBirthDay}&UserBirthMoth={UserBirthMoth}&UserBirthYear={UserBirthYear}&Gender={Gender} |
CreateSubUser Creates a Sub user return values: 1 = Success -1 = Parent user doesnt exist,or wrong username and password -2 = Parent User is not active or Parent is a SUB USER -3 = Session timed out or wrong session -4 = Username already exists |
| https://api.moursel.com/api/Moursel/deletePendingBatch?BatchID={BatchID}&Session={Session} |
deletePendingBatch Delete a pending batch and refund points return values: 1 = Success 0 = Batch cannot be deleted -1 = Session has expired or wrong session -2 = System error -3 = System error |
| https://api.moursel.com/api/Moursel/getAllSubUsers?logId={logId} |
getAllSubUsers Gets the UserNames of all sub users return values: Success = Array of all usernames Failure = Array of error code |
| https://api.moursel.com/api/Moursel/getBalance?logID={logID} |
getBalance Returns the User Balance return values: -1 = Session has expired or wrong session >=0 = User Balance |
| https://api.moursel.com/api/Moursel/getBatches?sessionID={sessionID}&FromDate={FromDate}&toDate={toDate} |
getBatches Returns user Batches Parameters: Session [string] = Log Id returned on log in FromDate = Format: YYYYMMDDhhmm. (Allow null) toDate = Format: YYYYMMDDhhmm. (Allow null) return values: Array of string containing (BatchId~sendDate~Status~SenderId~NbrReceivers~ message )Status: 1=Pending, 2=Sent, 12=Error, 14=Processing If FromDate = empty and ToDate = empty: Top 25 records order by sendDate Descending If toDate = empty: Top 50 records order by sendDate Ascending -1 = Session timed out or wrong session -2 = Wrong FromDate, ToDate -3 = Unspecified error |
| https://api.moursel.com/api/Moursel/getDeliveryReport?sessionID={sessionID}&BatchId={BatchId} |
getDeliveryReport Returns delivery report for all batch receivers return values: Array of string containing (Mobile~sendDate~DateDone~Status ) Status: 20= SMS delivered; 21=SMS not delivered; 22=SMS waiting delivery report -1 = Session timed out or wrong session -2 = Wrong BatchId -3 = Unspecified error |
| https://api.moursel.com/api/Moursel/getSenderID?logID={logID} | No Documentation available |
| https://api.moursel.com/api/Moursel/getSubUserDetails?logId={logId}&SubUserUname={SubUserUname} |
getSubUserDetails Returns the details of a sub user return values: Success = Array of all sub user details Failure = Array of error code |
| https://api.moursel.com/api/Moursel/GetUnitPrice?MobileNumber={MobileNumber}&Session={Session} |
GetUnitPrice Returns the price of the SMS for a specific number return values: >0 = The price as decimal -1 = Session has expired or wrong session -2 = System error |
| https://api.moursel.com/api/Moursel/isAlive?sessionID={sessionID} |
isAlive Tests if session is still active return values: True = Session still alive False = Session has expired |
| https://api.moursel.com/api/Moursel/RefillSubUSerBalance?logId={logId}&SubUserUName={SubUserUName}&Amount={Amount} |
RefillSubUSerBalance Refills a sub user’s Balance by transaction from parent balance Or vice- versa Parameters: logId [string] = Log Id returned on log in SubUserUName [string] = The UserName of the Sub User Amount [Integer] = Amount to be transmited. Amount could be positive for increase and negative for decrease return values: 1 = Success -1 = Balance is less than the amount -2 = No Balance -3 = User is not active -4 = Session Timed Out or wrong session -5 = Sub username is incorrect -6 = User doesn’t exist |
| https://api.moursel.com/api/Moursel/sendSMScs?logID={logID}&smsMessage={smsMessage}&ReceiverNumbers={ReceiverNumbers}&MessageType={MessageType}&getSenderID={getSenderID}&sendDate={sendDate}&multiBatch={multiBatch}&isLastBatch={isLastBatch} |
sendSMScs Sends an SMS Parameters: logId [string] = Log Id returned on log in smsMessage [string] = Message text to be sent.159 characters for Latin message and 70 characters for Unicode message ReceiverNumbers [string] = string containing the mobile receivers numbers separated by ~Format: Country calling code+ Mobile Number+~ Example:9613XXXXXX~96170YYYYYY~ MessageType [String] = 1 for Latin,6 for Unicode getSenderID [string] One of the values returned by getSenderID method sendDate [string] = String indicating the date to send message.Format: YYYYMMDDhhmm. '0' for now() multiBatch = 0 for single Batch, 1 for multi Batch isLastBatch = 1 for the Last Batch return values: > 0 (BatchId ) = Success 0 = Wrong data -1 = Session timed out or wrong session -2 = No receivers -3 = Not enough balance -4 = Invalid receivers -5 = Unspecified error -6 = Message > 960 characters |
| https://api.moursel.com/api/Moursel/updateBatchDate?BatchID={BatchID}&sendDate={sendDate}&Session={Session} |
updateBatchDate Change send date of a pending batch Parameters: Session [string] = Log Id returned on log in sendDate [string] = String indicating the date to send message.Format: YYYYMMDDhhmm. '0' for now() BatchID [ Integer] = BatchId returned by SendSMScs function return values: 1 = Success 0 = Invalid Batch -1 = Session has expired or wrong session -2 = System error |