# WINSMS API

> WINSMS API on Apizie: 11 endpoints (Get your current WinSMS credit balance, Transfer credits between main and sub accounts., Get a list of incoming short/long code messages, Get a list of incoming SMS messages, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/communication:winsms-co-za/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:winsms-co-za`
- Category: Communication
- Status: byok
- Source: http://support.winsms.co.za/
- Page: https://apizie.tech/api/communication/winsms-co-za
- OpenAPI: https://apizie.tech/api/communication/winsms-co-za/openapi.json

WinSMS RESTful API

## Endpoints

### Get your current WinSMS credit balance
`GET https://apizie.tech/v1/communication:winsms-co-za/get-credit-balance` (byok)

### Transfer credits between main and sub accounts.
`POST https://apizie.tech/v1/communication:winsms-co-za/transfer-credits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a list of incoming short/long code messages
`GET https://apizie.tech/v1/communication:winsms-co-za/get-short-code-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0. |
| limit | integer | no | ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000. |

### Get a list of incoming SMS messages
`GET https://apizie.tech/v1/communication:winsms-co-za/get-incoming-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0. |
| limit | integer | no | ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000. |

### Get a list of incoming opt-out SMS messages
`GET https://apizie.tech/v1/communication:winsms-co-za/get-optout-messages` (byok)

### Send SMS messages
`POST https://apizie.tech/v1/communication:winsms-co-za/sms-send` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send multiple different SMS messages
`POST https://apizie.tech/v1/communication:winsms-co-za/sms-send-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get SMS delivery statuses
`POST https://apizie.tech/v1/communication:winsms-co-za/sms-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a list of scheduled SMS messages
`GET https://apizie.tech/v1/communication:winsms-co-za/get-scheduled-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0. |
| limit | integer | no | ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000. |

### Delete scheduled SMS messages and refund credits
`POST https://apizie.tech/v1/communication:winsms-co-za/delete-scheduled-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get a list of all Sub Accounts.
`GET https://apizie.tech/v1/communication:winsms-co-za/get-sub-accounts` (byok)

## Example
```
curl "https://apizie.tech/v1/communication:winsms-co-za/get-credit-balance" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the WINSMS API?
Create a free Apizie key, then send GET https://apizie.tech/v1/communication:winsms-co-za/get-credit-balance with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the WINSMS API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. WINSMS itself also needs your own key from winsms.co.za.

### Can AI agents use the WINSMS API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:winsms-co-za.

### What is the status of the WINSMS API?
Needs your own provider key (bring your own key)