Carrier

Telephony providers: Twilio and Telnyx.

Carrier

The carrier delivers the phone call to Patter. Patter supports Twilio and Telnyx. Both share DTMF, call transfer, AMD, status callbacks, and cost tracking; recording is Twilio-only.

You configure one carrier per Patter instance by passing an instance to the carrier field. Each carrier class falls back to environment variables when constructor arguments are omitted.

Both carriers are imported by name from the package barrel: import { Twilio, Telnyx } from "getpatter".

Twilio

import { Patter, Twilio } from "getpatter";

const phone = new Patter({
  carrier: new Twilio(),                              // reads env
  phoneNumber: "[phone]",
});

// Or explicitly:
const phone = new Patter({
  carrier: new Twilio({ accountSid: "AC...", authToken: "..." }),
  phoneNumber: "[phone]",
});

Parameter	Type	Default	Description
accountSid	string	—	Twilio Account SID (starts with AC). Reads from TWILIO_ACCOUNT_SID when omitted.
authToken	string	—	Twilio Auth Token. Reads from TWILIO_AUTH_TOKEN when omitted.

On serve(), Patter automatically sets the voice_url on the Twilio number to https://<webhookUrl>/webhooks/twilio/voice via the Twilio REST API — no manual Console configuration needed.

Signature verification

The Auth Token is also used to verify every Twilio webhook with HMAC-SHA1 against the X-Twilio-Signature header. Requests with invalid signatures are rejected with HTTP 403.

Telnyx

import { Patter, Telnyx } from "getpatter";

const phone = new Patter({
  carrier: new Telnyx(),                              // reads env
  phoneNumber: "[phone]",
});

// Or explicitly:
const phone = new Patter({
  carrier: new Telnyx({
    apiKey: "KEY...",
    connectionId: "2000000000000000000",
    publicKey: "...",   // optional — enables Ed25519 signature verification
  }),
  phoneNumber: "[phone]",
});

Parameter	Type	Default	Description
apiKey	string	—	Telnyx API v2 key. Reads from TELNYX_API_KEY when omitted.
connectionId	string	—	Call Control Application ID. Reads from TELNYX_CONNECTION_ID when omitted.
publicKey	string	—	Optional. Ed25519 public key for webhook signature verification. Reads from TELNYX_PUBLIC_KEY when omitted.

Signature verification

When publicKey is set (or TELNYX_PUBLIC_KEY is present), every Telnyx webhook is verified with Ed25519. Requests older than 5 minutes are rejected (replay protection).

Webhook Endpoints

The embedded server exposes these endpoints regardless of carrier choice:

Endpoint	Purpose
POST /webhooks/twilio/voice	Incoming Twilio call → returns TwiML to start streaming.
POST /webhooks/twilio/status	Call lifecycle status callbacks (initiated, ringing, answered, completed).
POST /webhooks/twilio/recording	Recording completion callbacks.
POST /webhooks/twilio/amd	Async AMD (answering machine detection) results.
POST /webhooks/telnyx/voice	Incoming Telnyx call → returns Call Control commands.

What’s Next

STT

Speech-to-text providers.

LLM

Language model providers.

TTS

Text-to-speech providers.

Tunneling

Expose your local server publicly.