WinSMS is a bulk SMS messaging platform for sending business text messages and alerts.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

Winsms

WinSMS is a bulk SMS messaging platform for sending business text messages and alerts.

Base URL: https://www.winsms.co.za/api/rest/v1
Auth: header:AUTHORIZATION (pass your key via the apiKey input)

Operations

getcreditbalance — GET /credits/balance — Get your current WinSMS credit balance
getshortcodemessages — GET /shortcode/incoming — Get a list of incoming short/long code messages
getincomingmessages — GET /sms/incoming — Get a list of incoming SMS messages
getoptoutmessages — GET /sms/incoming/optout — Get a list of incoming opt-out SMS messages
getscheduledmessages — GET /sms/scheduled — Get a list of scheduled SMS messages
getsubaccounts — GET /subaccounts — Get a list of all Sub Accounts.

Inputs

apiKey — your winsms API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops

Example

operation: getcreditbalance
apiKey: <your key>

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

error
operation
result
status

Input Properties

Every property this tool accepts, from its own tool.iml.

Property	Type	Required	Default	Description
`apiKey`	string	yes	—	DEPRECATED — bind an API Key credential to the task with `credentialName` instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
`operation`	string	yes	—	One of: getcreditbalance, getshortcodemessages, getincomingmessages, getoptoutmessages, getscheduledmessages, getsubaccounts
`query`	string	no	—	Optional query params as a JSON object string, e.g. {"limit": 10}.