Thesmsworks SDK

The SMS Works API client, generated from the OpenAPI spec.

The SMS Works provides a low-cost, reliable SMS API for developers.

Learn more about The SMS Works API at thesmsworks.co.uk.

This is an unofficial SDK for the The SMS Works public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

TypeScript, Python, PHP, Golang, Ruby, Lua, C, Clojure, C++, C#, Dart, Elixir, Haskell, Java, JavaScript, Kotlin, OCaml, Perl, Rust, Scala, Swift, Zig SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as 9 semantic entities that you call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are Capitalised to mark them as the primary surface, each with the operations they support (load, create, remove):

const client = new ThesmsworksSDK()
const batch = await client.Batch().load()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = ThesmsworksSDK.test()
const batch = await client.Batch().load({ id: 'test01' })
// batch is a bare Batch populated with mock data
console.log(batch)

Python

client = ThesmsworksSDK.test()
batch = client.Batch().load({"id": "test01"})
print(batch)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = ThesmsworksSDK::test([
    "entity" => ["batch" => ["test01" => ["id" => "test01"]]],
]);
$batch = $client->Batch()->load(["id" => "test01"]);

Golang

client := sdk.Test()
result, err := client.Batch(nil).Load(
    map[string]any{"id": "test01"}, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = ThesmsworksSDK.test({
  "entity" => { "batch" => { "test01" => { "id" => "test01" } } },
})
batch = client.Batch.load({ "id" => "test01" })

Lua

local client = sdk.test()
local result, err = client:Batch():load({ id = "test01" })

C

#include "core/api.h"

ThesmsworksSDK* client = test_sdk(NULL, NULL);
PNError* err = NULL;
Entity* batch = thesmsworks_batch(client, NULL);
voxgig_value* batch_rec = batch->vt->load(batch, cmap(1, "id", v_str("test01")), NULL, &err);
printf("%s\n", voxgig_to_json(batch_rec));

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.batch :as e-batch]
         '[voxgig.struct :as vs])

(def client (api/test-sdk nil nil))
(def batch (e-batch/load (api/batch client nil) (vs/jm "id" "test01") nil))
(println batch)

C++

auto client = ThesmsworksSDK::testSDK();
Value batch = client->batch()->load(vmap({{"id", Value("test01")}}), Value::undef());
std::cout << Struct::jsonify(batch) << std::endl;

C#

var client = ThesmsworksSDK.TestSDK(null, null);
var batch = client.Batch().Load(new Dictionary<string, object?> { ["id"] = "test01" });
Console.WriteLine(batch);

Dart

import 'package:thesmsworks_sdk/ThesmsworksSDK.dart';

Future<void> main() async {
  final client = ThesmsworksSDK.test();
  final batch = await client.Batch().load({'id': 'test01'});
  print(batch);
}

Elixir

alias Thesmsworks.Helpers, as: H

sdk = Thesmsworks.test()
batch = Thesmsworks.batch(sdk)
record = Thesmsworks.Entity.Batch.load(batch, H.deep(%{"id" => "test01"}))
IO.inspect(record)

Haskell

import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.testSdk0
  ent <- Sdk.batch sdk VNoval
  arg <- jo [("id", VStr "test01")]
  ctrl <- emptyMap
  batch <- Sdk.eLoad ent arg ctrl
  print batch

Java

ThesmsworksSDK client = ThesmsworksSDK.testSDK(null, null);
Object batch = client.batch(null).load(Map.of("id", "test01"), null);
System.out.println(batch);

JavaScript

const client = ThesmsworksSDK.test()
const batch = await client.Batch().load({ id: 'test01' })
// batch is a bare entity populated with mock data
console.log(batch)

Kotlin

val client = ThesmsworksSDK.testSDK(null, null)
val batch = client.batch(null).load(mutableMapOf<String, Any?>("id" to "test01"), null)
println(batch)

OCaml

let () =
  let client = Sdk_client.test () in
  let result = (Sdk_client.batch client Noval).e_load (jo [("id", (Str "test01"))]) Noval in
  print_endline (stringify result)

Perl

use lib 'perl/lib';
use ThesmsworksSDK;

my $client = ThesmsworksSDK->test(undef, undef);
my $batch = $client->Batch->load({ 'id' => 'test01' });
print "$batch->{id}\n";

Rust

use thesmsworks_sdk::{jo, test_sdk, Value};

let client = test_sdk(Value::Noval, Value::Noval);
let batch = client.batch(Value::Noval).load(jo(vec![("id", Value::str("test01"))]), Value::Noval).unwrap();
println!("{:?}", batch);

Scala

val client = ThesmsworksSDK.testSDK(null, null)
val batch = client.batch(null).load(java.util.Map.of("id", "test01"), null)
println(batch)

Swift

let client = ThesmsworksSDK.testSDK(nil, nil)
let batch = try client.Batch().load(VMap([("id", .string("test01"))]), nil)
print(batch)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.test_sdk(h.vnull(), h.vnull());
switch (client.batch(h.vnull()).load(h.jo(&.{.{ "id", h.vstr("test01") }}), h.vnull())) {
    .ok => |batch| std.debug.print("{s}\n", .{h.stringify(batch)}),
    .err => |e| std.debug.print("load failed: {s}\n", .{e.msg}),
}

Packages

Quickstart

TypeScript

import { ThesmsworksSDK } from '@voxgig-sdk/thesmsworks'

const client = new ThesmsworksSDK({
  apikey: process.env.THESMSWORKS_APIKEY,
})


// Load a specific onetimepassword (returns a OneTimePassword)
const onetimepassword = await client.OneTimePassword().load({
  messageid: 'example_messageid',
})
console.log(onetimepassword)

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o thesmsworks-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "thesmsworks": {
      "command": "/abs/path/to/thesmsworks-mcp"
    }
  }
}

Entities

The API exposes 9 entities:

The operations available across these entities are load, create, remove — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

import os
from thesmsworks_sdk import ThesmsworksSDK

client = ThesmsworksSDK({
    "apikey": os.environ.get("THESMSWORKS_APIKEY"),
})


# Load a specific batch (returns the record, raises on error)
batch = client.Batch().load({"id": "example_id"})
print(batch)

PHP

<?php
require_once 'thesmsworks_sdk.php';

$client = new ThesmsworksSDK([
    "apikey" => getenv("THESMSWORKS_APIKEY"),
]);


// Load a specific batch (returns the bare record; throws on error)
$batch = $client->Batch()->load(["id" => "example_id"]);
print_r($batch);

Golang

import sdk "github.com/voxgig-sdk/thesmsworks-sdk/go"

client := sdk.NewThesmsworksSDK(map[string]any{
    "apikey": os.Getenv("THESMSWORKS_APIKEY"),
})


// Load a specific onetimepassword
oneTimePassword, err := client.OneTimePassword(nil).Load(
    map[string]any{"messageid": "example_messageid"}, nil,
)
if err != nil {
    panic(err)
}
fmt.Println(oneTimePassword)

Ruby

require_relative "Thesmsworks_sdk"

client = ThesmsworksSDK.new({
  "apikey" => ENV["THESMSWORKS_APIKEY"],
})


# Load a specific batch (returns the bare record; raises on error)
batch = client.Batch.load({ "id" => "example_id" })
puts batch

Lua

local sdk = require("thesmsworks_sdk")

local client = sdk.new({
  apikey = os.getenv("THESMSWORKS_APIKEY"),
})


-- Load a specific batch
local batch, err = client:Batch():load({ id = "example_id" })
print(batch)

C

#include "core/api.h"

ThesmsworksSDK* client = thesmsworks_sdk_new(cmap(1,
    "apikey", v_str(getenv("THESMSWORKS_APIKEY"))));
PNError* err = NULL;


Entity* batch = thesmsworks_batch(client, NULL);
// Load a specific batch (returns the record, sets *err on failure)
voxgig_value* batch_rec = batch->vt->load(batch, cmap(1, "id", v_str("example_id")), NULL, &err);
printf("%s\n", voxgig_to_json(batch_rec));

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.batch :as e-batch]
         '[voxgig.struct :as vs])

(def client (api/make-sdk (vs/jm "apikey" (System/getenv "THESMSWORKS_APIKEY"))))


;; Load a specific batch (returns the record, raises on error)
(def batch (e-batch/load (api/batch client nil) (vs/jm "id" "example_id") nil))
(println batch)

C++

#include <cstdlib>
#include "core/sdk.hpp"

using namespace sdk;

const char* apikey = std::getenv("THESMSWORKS_APIKEY");
auto client = std::make_shared<ThesmsworksSDK>(vmap({
    {"apikey", Value(apikey ? apikey : "")},
}));


// Load a specific batch (returns the record, throws on error)
Value batch = client->batch()->load(vmap({{"id", Value("example_id")}}), Value::undef());
std::cout << Struct::jsonify(batch) << std::endl;

C#

using ThesmsworksSdk;

var client = new ThesmsworksSDK(new Dictionary<string, object?>
{
    ["apikey"] = Environment.GetEnvironmentVariable("THESMSWORKS_APIKEY"),
});


// Load a specific batch (returns the record, raises on error)
var batch = client.Batch().Load(new Dictionary<string, object?> { ["id"] = "example_id" });
Console.WriteLine(batch);

Dart

import 'dart:io';
import 'package:thesmsworks_sdk/ThesmsworksSDK.dart';

Future<void> main() async {
  final client = ThesmsworksSDK({
    'apikey': Platform.environment['THESMSWORKS_APIKEY'],
  });


  // Load a specific batch (returns the record, throws on error)
  final batch = await client.Batch().load({'id': 'example_id'});
  print(batch);
}

Elixir

alias Thesmsworks.Helpers, as: H

sdk = Thesmsworks.new(H.deep(%{"apikey" => System.get_env("THESMSWORKS_APIKEY")}))

batch = Thesmsworks.batch(sdk)

# Load a specific batch (returns the record, raises on error)
record = Thesmsworks.Entity.Batch.load(batch, H.deep(%{"id" => "example_id"}))
IO.inspect(record)

Haskell

import System.Environment (lookupEnv)
import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  mkey <- lookupEnv "THESMSWORKS_APIKEY"
  opts <- jo [("apikey", maybe VNoval VStr mkey)]
  sdk <- Sdk.newSdk opts

  -- Load a specific batch (returns the record, raises on error)
  ent2 <- Sdk.batch sdk VNoval
  m <- jo [("id", VStr "example_id")]
  ctrl2 <- emptyMap
  batch <- Sdk.eLoad ent2 m ctrl2
  print batch

Java

import voxgig.thesmsworkssdk.core.ThesmsworksSDK;

Map<String, Object> options = new java.util.LinkedHashMap<>();
options.put("apikey", System.getenv("THESMSWORKS_APIKEY"));
ThesmsworksSDK client = new ThesmsworksSDK(options);


// Load a specific batch (returns the record, raises on error)
Object batch = client.batch(null).load(Map.of("id", "example_id"), null);
System.out.println(batch);

JavaScript

const { ThesmsworksSDK } = require('@voxgig-sdk/thesmsworks-js')

const client = new ThesmsworksSDK({
  apikey: process.env.THESMSWORKS_APIKEY,
})


// Load a specific onetimepassword (returns the entity)
const onetimepassword = await client.OneTimePassword().load({
  messageid: 'example_messageid',
})
console.log(onetimepassword)

Kotlin

import voxgig.thesmsworkssdk.core.ThesmsworksSDK

val client = ThesmsworksSDK(mutableMapOf<String, Any?>(
    "apikey" to System.getenv("THESMSWORKS_APIKEY"),
))


// Load a specific batch (returns the record, raises on error)
val batch = client.batch(null).load(mutableMapOf<String, Any?>("id" to "example_id"), null)
println(batch)

OCaml

open Voxgig_struct
open Sdk_helpers

let () =
  let client = Sdk_client.make (jo [("apikey", Str (Sys.getenv "THESMSWORKS_APIKEY"))]) in
  (* Load a specific batch (returns the record; raises on error) *)
  let batch = (Sdk_client.batch client Noval).e_load (jo [("id", (Str "example_id"))]) Noval in
  print_endline (stringify batch)

Perl

use lib 'perl/lib';
use ThesmsworksSDK;

my $client = ThesmsworksSDK->new({
    'apikey' => $ENV{'THESMSWORKS_APIKEY'},
});


# Load a specific batch (returns the bare record; dies on error)
my $batch = $client->Batch->load({ 'id' => 'example_id' });
print "$batch->{id}\n";

Rust

use thesmsworks_sdk::{jo, ThesmsworksSDK, Value};

let client = ThesmsworksSDK::new(jo(vec![
    ("apikey", Value::str(std::env::var("THESMSWORKS_APIKEY").unwrap_or_default())),
]));


// Load a specific batch (returns the record, Err on failure)
let batch = client.batch(Value::Noval).load(jo(vec![("id", Value::str("example_id"))]), Value::Noval).unwrap();
println!("{:?}", batch);

Scala

import voxgig.thesmsworkssdk.core.ThesmsworksSDK

val options = new java.util.LinkedHashMap[String, Object]()
options.put("apikey", System.getenv("THESMSWORKS_APIKEY"))
val client = new ThesmsworksSDK(options)


// Load a specific batch (returns the record, raises on error)
val batch = client.batch(null).load(java.util.Map.of("id", "example_id"), null)
println(batch)

Swift

import ThesmsworksSdk

let options = VMap()
options.entries["apikey"] = .string(
    ProcessInfo.processInfo.environment["THESMSWORKS_APIKEY"] ?? "")
let client = ThesmsworksSDK(options)


// Load a specific batch (returns the record, throws on error)
let batch = try client.Batch().load(VMap([("id", .string("example_id"))]), nil)
print(batch)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.ThesmsworksSDK.new(h.jo(&.{
    .{ "apikey", h.vstr(std.posix.getenv("THESMSWORKS_APIKEY") orelse "") },
}));


// Load a specific batch (Ok is the record, .err on failure)
switch (client.batch(h.vnull()).load(h.jo(&.{.{ "id", h.vstr("example_id") }}), h.vnull())) {
    .ok => |batch| std.debug.print("{s}\n", .{h.stringify(batch)}),
    .err => |e| std.debug.print("load failed: {s}\n", .{e.msg}),
}

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

C:

PNError* err = NULL;
voxgig_value* result = sdk_direct(client, cmap(3,
    "path", v_str("/api/resource/{id}"),
    "method", v_str("GET"),
    "params", cmap(1, "id", v_str("example"))), &err);

Clojure:

(def result
  (api/direct client
    (vs/jm "path" "/api/resource/{id}"
           "method" "GET"
           "params" (vs/jm "id" "example"))))

C++:

Value result = client->direct(vmap({
    {"path", Value("/api/resource/{id}")},
    {"method", Value("GET")},
    {"params", vmap({{"id", Value("example")}})},
}));

C#:

var result = client.Direct(new Dictionary<string, object?>
{
    ["path"] = "/api/resource/{id}",
    ["method"] = "GET",
    ["params"] = new Dictionary<string, object?> { ["id"] = "example" },
});

Dart:

final result = await client.direct({
  'path': '/api/resource/{id}',
  'method': 'GET',
  'params': {'id': 'example'},
});

Elixir:

result = Thesmsworks.direct(sdk, Thesmsworks.Helpers.deep(%{
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => %{"id" => "example"}
}))

Haskell:

import qualified SdkClient as Sdk
import qualified SdkFeatures as F
import VoxgigStruct (Value (..))
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.newSdk0
  params <- jo [("id", VStr "example")]
  args <- jo [("path", VStr "/api/resource/{id}"), ("method", VStr "GET"), ("params", params)]
  result <- F.direct sdk args
  print result

Java:

Map<String, Object> result = client.direct(Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", Map.of("id", "example")));

JavaScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Kotlin:

val result = client.direct(mutableMapOf<String, Any?>(
    "path" to "/api/resource/{id}",
    "method" to "GET",
    "params" to mapOf("id" to "example")))

OCaml:

let result = Sdk_client.direct client (jo [
    ("path", Str "/api/resource/{id}");
    ("method", Str "GET");
    ("params", jo [("id", Str "example")]);
]) in
ignore result

Perl:

my $result = $client->direct({
    'path' => '/api/resource/{id}',
    'method' => 'GET',
    'params' => { 'id' => 'example' },
});

Rust:

let result = client.direct(jo(vec![
    ("path", Value::str("/api/resource/{id}")),
    ("method", Value::str("GET")),
    ("params", jo(vec![("id", Value::str("example"))])),
]));

Scala:

val result = client.direct(java.util.Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", java.util.Map.of("id", "example")))

Swift:

let result = client.direct(VMap([
    ("path", .string("/api/resource/{id}")),
    ("method", .string("GET")),
    ("params", .map([("id", .string("example"))])),
]))

Zig:

const result = client.direct(h.jo(&.{
    .{ "path", h.vstr("/api/resource/{id}") },
    .{ "method", h.vstr("GET") },
    .{ "params", h.jo(&.{.{ "id", h.vstr("example") }}) },
}));

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua
• C
• Clojure
• C++
• C#
• Dart
• Elixir
• Haskell
• Java
• JavaScript
• Kotlin
• OCaml
• Perl
• Rust
• Scala
• Swift
• Zig

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://thesmsworks.co.uk/contact

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the The SMS Works API OpenAPI spec by @voxgig/sdkgen.