# The SMS Works API API

> The SMS Works API API on Apizie: 18 endpoints (Sends a collection of unique SMS messages. Batches may contain up to 5000 messages at a time., Schedules a batch of SMS messages to be sent at the date time you specify, Send a single SMS message to multiple recipients. Batches may contain up to 5000 messages at a time., Retrieve all messages in a batch with the given batch ID, …) 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:thesmsworks-co-uk/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:thesmsworks-co-uk`
- Category: Communication
- Status: byok
- Source: https://thesmsworks.co.uk
- Page: https://apizie.tech/api/communication/thesmsworks-co-uk
- OpenAPI: https://apizie.tech/api/communication/thesmsworks-co-uk/openapi.json

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed messages are refunded.

## Endpoints

### Sends a collection of unique SMS messages. Batches may contain up to 5000 messages at a time.
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-batch-any` (byok)

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

### Schedules a batch of SMS messages to be sent at the date time you specify
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-batch-schedule` (byok)

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

### Send a single SMS message to multiple recipients. Batches may contain up to 5000 messages at a time.
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-batch-send` (byok)

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

### Retrieve all messages in a batch with the given batch ID
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-batch-batchid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| batchid | string | yes | The ID of the batch you would like returned |

### Cancels a scheduled SMS message
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/delete-batches-schedule-batchid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| batchid | string | yes | The ID of the batch you would like returned |

### Returns the number of credits currently available on the account
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-credits-balance` (byok)

### Sends an SMS flash message, which appears on the recipients lock screen
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/send-flash-message` (byok)

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

### Schedules an SMS message to be sent at the date-time you specify
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-message-schedule` (byok)

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

### Send an SMS Message
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-message-send` (byok)

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

### Retrieve up to 1000 messages matching your search criteria
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-messages` (byok)

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

### Get failed messages matching your search criteria
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-messages-failed` (byok)

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

### Get unread uncoming messages matching your search criteria
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-messages-inbox` (byok)

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

### Returns a list of messages scheduled from your account, comprising any messages scheduled in the last 3…
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-messages-schedule` (byok)

### Cancels a scheduled SMS message
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/delete-messages-schedule-messageid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| messageid | string | yes | The ID of the message you would like returned |

### Retrieve a logged message by the message ID
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-messages-messageid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| messageid | string | yes | The ID of the message you would like returned |

### Delete the message with the mathcing messageid
`POST https://apizie.tech/v1/communication:thesmsworks-co-uk/delete-messages-messageid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| messageid | string | yes | The ID of the message you would like returned |

### Returns a sample error object for the given error code. Useful for designing code to react to errors when…
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-utils-errors-errorcode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| errorcode | string | yes | The code of the error you would like returned |

### Returns the customer ID to the caller
`GET https://apizie.tech/v1/communication:thesmsworks-co-uk/get-utils-test` (byok)

## Example
```
curl "https://apizie.tech/v1/communication:thesmsworks-co-uk/post-batch-any" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the The SMS Works API API?
Create a free Apizie key, then send POST https://apizie.tech/v1/communication:thesmsworks-co-uk/post-batch-any with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the The SMS Works API 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:thesmsworks-co-uk.

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