Send SMS with Bun

Send your first text from Bun with the TextKit SDK.

Prompt for your AI agent

Paste this into Claude Code, Cursor or any coding agent to have it do the integration:

text
Add SMS sending to this Bun project with TextKit.

- Docs for this stack: https://jointextkit.com/docs/send-with-bun.md
- API: POST https://api.jointextkit.com/v1/messages with `Authorization: Bearer
  <key>` and a JSON body `{"to": "+1...", "body": "..."}`.
- Use the official SDK: `bun add jointextkit`, then `new
  TextKit().messages.send({ to, body })`.
- Read the key from the `TEXTKIT_API_KEY` environment variable. Never hardcode
  it or send it to the browser.
- Phone numbers are E.164 and US or Canada only (`+1` followed by 10 digits).
- A test key (`ssms_sk_test_`) simulates: `+15005550006` always ends `delivered`
  and no phone gets a text.
- Errors are JSON: `{"error": {"code", "message", "param"}}` with a 4xx status.
  On `429`, wait `Retry-After` seconds and retry.
- Send only from server code that runs after a real event (a signup, an order).
  Never expose an endpoint that texts any number a visitor types.

Before you start

  • An API key. Create a free account and copy the test key (ssms_sk_test_...) from Home in the console. It works at once, no card.
  • Bun 1.0 or later.
  • Put the key in an environment variable:
bash
export TEXTKIT_API_KEY=ssms_sk_test_...

1. Install the SDK

bash
bun add jointextkit

Put TEXTKIT_API_KEY=ssms_sk_test_... in .env: Bun loads it for you.

2. Send an SMS

Create send.ts:

typescript
import { TextKit } from 'jointextkit';

const sms = new TextKit(); // reads TEXTKIT_API_KEY

const message = await sms.messages.send({
  to: '+15005550006',
  body: 'Hello from TextKit',
});

console.log(message.id, message.status);

3. Run it

bash
bun send.ts

It prints the message ID (msg_...) and delivered.

What the test key did

+15005550006 is a sandbox number: the send comes back delivered and no phone gets a text (the response says "simulated": true). Put your own verified phone in to and the test key texts it for real. See Sandbox & test numbers.

Handle errors

The SDK throws a TextKitError with the API's code, status and message (plus param for a bad field and retryAfter on a rate limit). It retries network failures and 429s for you, with an idempotency key, so a retry never sends twice.

javascript
import { TextKit, TextKitError } from 'jointextkit';

try {
  await sms.messages.send({ to: '+15005550006', body: 'Hello from TextKit' });
} catch (err) {
  if (err instanceof TextKitError) {
    // err.code: 'invalid_request', 'rate_limited', ...  err.status: the HTTP status
    console.error(err.status, err.code, err.message);
  } else {
    throw err;
  }
}
StatusCodeWhat to do
400invalid_requestA field is missing or malformed; param names it.
401invalid_api_keyThe key is missing, revoked or mistyped.
402insufficient_creditsAdd credits; nothing was sent or charged.
403recipient_opted_outThey texted STOP. Do not retry.
429rate_limitedWait Retry-After seconds, then retry.

Every code is in Errors.

Go live

  1. Add a number in the console.
  2. Register your use case. We file your 10DLC registration; toll-free numbers use a guided verification form. Until carriers approve it, the number texts only your verified numbers. See Compliance & registration.
  3. Swap in a live key (ssms_sk_live_...). The code stays the same.

Next steps

  • Webhooks: delivery receipts and replies, pushed to your server.
  • Verify: one-time codes in two calls, billed only when verified.
  • Send an SMS: every field the endpoint takes.
  • All quickstarts: the same guide for other languages and frameworks.