WINSMS
WinSMS RESTful API
Communication#openapi#messaging
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
WinSMS RESTful API
Endpoints 11
credits
- GETGet your current WinSMS credit balance
/credits/balanceGet the current remaining credit balance for the account. *Note* - The credit balance is expressed as a value with a single decimal place. - POSTTransfer credits between main and sub accounts.
/credits/transferTransfer credits between accounts. From Main account to Sub account. From Sub account to Main account. From Sub account to another Sub account. Your WinSMS…
shortcode
- GETGet a list of incoming short/long code messages
/shortcode/incoming?offset=0&limit=100*Only available to users with a WinSMS Short/Long Code.* Get a list of all incoming short/long code messages received by the account. Only the first 100…
sms
- GETGet a list of incoming SMS messages
/sms/incoming?offset=0&limit=100Get a list of all incoming SMS messages received by the account. Only the first 100 incoming messages will be returned if no *offset* and *limit* parameters… - GETGet a list of incoming opt-out SMS messages
/sms/incoming/optoutGet a list of all opt-out SMS messages received by the account, as well as all manually added opt-out numbers.<br> - POSTSend SMS messages
/sms/outgoing/sendSubmit 1 or more SMS messages to be sent by WinSMS. Maximum 1000 recipients per request. The SMS message text can be a maximum of 918 characters long. If you… - POSTSend multiple different SMS messages
/sms/outgoing/sendmultiSubmit multiple different SMS messages to be sent to multiple recipients. Maximum 1000 recipients across all messages. Each SMS message text can be a maximum… - POSTGet SMS delivery statuses
/sms/outgoing/statusGet a list of previously submitted SMS message delivery statuses. Post an array of API Message Ids received from the */sms/outgoing/send* endpoint. - GETGet a list of scheduled SMS messages
/sms/scheduled?offset=0&limit=100Get a list of all scheduled SMS messages that have not yet been sent. Only the first 100 scheduled messages will be returned if no *offset* and *limit*… - POSTDelete scheduled SMS messages and refund credits
/sms/scheduled/deleteDelete a list of previously scheduled SMS messages that have not yet been sent. Credits originally deducted for each SMS message will be refunded to your…
subaccounts
- GETGet a list of all Sub Accounts.
/subaccountsGet a list of all the Sub Accounts owned by the Main Account.
API details
- Base URL
https://www.winsms.co.za/api/rest/v1- Authentication
- An API key in the AUTHORIZATION header
- Operations
- 11 operations on 11 pathsGET 6POST 5
- Main resources
- sms 7credits 2shortcode 1subaccounts 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the WINSMS in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the WINSMS collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the AUTHORIZATION header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get your current WinSMS credit balance” (GET /credits/balance), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the WINSMS?
WinSMS RESTful API It is listed under Communication and has 11 endpoints.
Who publishes the WINSMS?
It is listed from Winsms's public API description (an OpenAPI document), not published by Winsms on Swastik Codes. Anyone who controls winsms.co.za can claim the profile by adding a DNS TXT record.
What is the base URL of the WINSMS?
Requests go to https://www.winsms.co.za/api/rest/v1. Endpoint paths are added to this base URL.
How do I authenticate with the WINSMS?
With an API key in the AUTHORIZATION header.
How many endpoints does the WINSMS have?
11 operations on 11 paths (6 GET, 5 POST). The largest groups are sms, credits, shortcode, subaccounts.
Is forking the WINSMS free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.