WINSMS
  1. credits
WINSMS
  • credits
    • Get your current WinSMS credit balance
      GET
    • Transfer credits between main and sub accounts.
      POST
  • shortcode
    • Get a list of incoming short/long code messages
      GET
  • sms
    • Get a list of incoming SMS messages
      GET
    • Get a list of incoming opt-out SMS messages
      GET
    • Send SMS messages
      POST
    • Send multiple different SMS messages
      POST
    • Get SMS delivery statuses
      POST
    • Get a list of scheduled SMS messages
      GET
    • Delete scheduled SMS messages and refund credits
      POST
  • subaccounts
    • Get a list of all Sub Accounts.
      GET
  1. credits

Transfer credits between main and sub accounts.

POST
/credits/transfer
Transfer credits between accounts.
From Main account to Sub account.
From Sub account to Main account.
From Sub account to another Sub account.
Your WinSMS account number and sub account number/s can be obtained by logging in to the WinSMS Client Zone (www.winsms.co.za/cz) with the main account's credentials.
The main account number is on the home tab and the sub account numbers are under the sub accounts tab.
Account numbers should be submitted as integers. Do not add the 'W' prefix.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://www.winsms.co.za/api/rest/v1/credits/transfer' \
--header 'Content-Type: application/json' \
--data-raw '{
    "receivingAccountNumber": 10345,
    "sendingAccountNumber": 7564,
    "transferQuantity": 100
}'
Response Response Example
200 - Example 1
{
    "statusCode": 200,
    "timeStamp": "20170120152253515",
    "transferSuccessful": true,
    "version": "1.0"
}

Request

Body Params application/json

Examples

Responses

🟢200OK
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠404Not found
🟠405Method Not Allowed
🟠413Payload Too Large
🟠415Unsupported Media Type
🟠422Unprocessable Entity
🔴500Internal Server Error
Modified at 2023-08-15 09:05:19
Previous
Get your current WinSMS credit balance
Next
Get a list of incoming short/long code messages
Built with