TypeScript SDK for the Handset business phone API — compliant two-way SMS, inbound voice, voicemail, and real phone numbers for your platform, one typed function per endpoint.

Generated from the OpenAPI spec, so it always matches the API.

npm install @handset/sdk

Usage

import { client } from "@handset/sdk/client";
import { createTenant, sendMessage, listConversations } from "@handset/sdk";

client.setConfig({
  headers: { Authorization: `Bearer ${process.env.HANDSET_API_KEY}` },
});

// Your customer, as a tenant
const tenant = await createTenant({
  body: { name: "Bayview Dental", timezone: "America/Los_Angeles" },
});

// Send a compliant text (threading, opt-outs, and 10DLC handled server-side)
await sendMessage({
  body: {
    from: "num_…",              // a tenant-owned number
    to: "+14155550199",
    body: "Your appointment is confirmed for 9:30 AM tomorrow.",
  },
});

// Read the thread back
const threads = await listConversations({ query: { tenant_id: tenant.data!.id } });

Every call returns { data, error, response }; pass test keys (hs_test_…) to run against the simulated carrier — free numbers, instant compliance, magic numbers for rehearsing failure.