Thesmsworks

The SMS Works API

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

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

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

Endpoints 18

batch messages

  • POSTPOST /batch/any/batch/anySends a collection of unique SMS messages. Batches may contain up to 5000 messages at a time.
  • POSTPOST /batch/schedule/batch/scheduleSchedules a batch of SMS messages to be sent at the date time you specify
  • POSTPOST /batch/send/batch/sendSend a single SMS message to multiple recipients. Batches may contain up to 5000 messages at a time.
  • GETGET /batch/{batchid}/batch/:batchidRetrieve all messages in a batch with the given batch ID
  • DELETEDELETE /batches/schedule/{batchid}/batches/schedule/:batchidCancels a scheduled SMS message

credits

  • GETGET /credits/balance/credits/balanceReturns the number of credits currently available on the account

messages

  • POSTsendFlashMessage/message/flashSends an SMS flash message, which appears on the recipients lock screen
  • POSTPOST /message/schedule/message/scheduleSchedules an SMS message to be sent at the date-time you specify
  • POSTPOST /message/send/message/sendSend an SMS Message
  • POSTPOST /messages/messagesRetrieve up to 1000 messages matching your search criteria
  • POSTPOST /messages/failed/messages/failedGet failed messages matching your search criteria
  • POSTPOST /messages/inbox/messages/inboxGet unread uncoming messages matching your search criteria
  • GETGET /messages/schedule/messages/scheduleReturns a list of messages scheduled from your account, comprising any messages scheduled in the last 3 months and any scheduled to send in the future
  • DELETEDELETE /messages/schedule/{messageid}/messages/schedule/:messageidCancels a scheduled SMS message
  • GETGET /messages/{messageid}/messages/:messageidRetrieve a logged message by the message ID
  • DELETEDELETE /messages/{messageid}/messages/:messageidDelete the message with the mathcing messageid

utils

  • GETGET /utils/errors/{errorcode}/utils/errors/:errorcodeReturns a sample error object for the given error code. Useful for designing code to react to errors when they occur for real.
  • GETGET /utils/test/utils/testReturns the customer ID to the caller

API details

Base URL
https://api.thesmsworks.co.uk/v1
Authentication
An API key in the Authorization header
Operations
18 operations on 18 pathsPOST 9GET 6DELETE 3
Main resources
messages 10batch messages 5utils 2credits 1
Response formats
application/json;charset=utf-8
Description format
Swagger 2.0, API version 1.8.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the The SMS Works API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the The SMS Works API collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “POST /batch/any” (POST /batch/any), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the The SMS Works API?

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed messages are refunded. It is listed under Communication and has 18 endpoints.

Who publishes the The SMS Works API?

It is listed from Thesmsworks's public API description (an OpenAPI document), not published by Thesmsworks on Swastik Codes. Anyone who controls thesmsworks.co.uk can claim the profile by adding a DNS TXT record.

What is the base URL of the The SMS Works API?

Requests go to https://api.thesmsworks.co.uk/v1. Endpoint paths are added to this base URL.

How do I authenticate with the The SMS Works API?

With an API key in the Authorization header.

How many endpoints does the The SMS Works API have?

18 operations on 18 paths (9 POST, 6 GET, 3 DELETE). The largest groups are messages, batch messages, utils, credits.

Is forking the The SMS Works API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.