​
Installing the SDK

1

Install the SDK

bun add contiguity
2

Initialize the Client

import { Contiguity } from "contiguity";
const contiguity = new Contiguity("contiguity_sk_...your_token...");

​
Managing Number Leases

Lease phone numbers to use as dedicated senders for your messages, improving deliverability and brand recognition.

​
Check Available Numbers

View available phone numbers that can be leased for your account.
const res = await contiguity.lease.available();

​
Get Number Details

Get detailed information about a specific phone number, including capabilities and pricing.
const res = await contiguity.lease.get({ 
  number: "+1234567890" 
});

​
Lease a Number

Create a lease for a phone number to use it as a sender.
const res = await contiguity.lease.create({ 
  number: "+1234567890",
  billing_method: "monthly" // or "service_contract"
});
You can also lease a number with default billing:
const res = await contiguity.lease.create({ 
  number: "+1234567890"
});

​
View Leased Numbers

Get a list of all numbers you currently have leased.
const res = await contiguity.lease.leased();

​
Get Lease Details

Get detailed information about a specific lease.
const res = await contiguity.lease.details({ 
  number: "+1234567890" 
});

​
Terminate a Lease

End a lease for a phone number when you no longer need it.
const res = await contiguity.lease.terminate({ 
  number: "+1234567890" 
});

​
Parameters

​
lease.available()

No parameters required. Returns all available numbers for leasing.

​
lease.get(params)

​
number
string
required
The phone number to get details for, in E.164 format (e.g., “+1234567890”).

​
lease.create(params)

​
number
string
required
The phone number to lease, in E.164 format (e.g., “+1234567890”).
​
billing_method
string
The billing method for the lease. Options: "monthly" for recurring monthly charges, "service_contract" for contract-based billing.

​
lease.leased()

No parameters required. Returns all currently leased numbers.

​
lease.details(params)

​
number
string
required
The leased phone number to get details for, in E.164 format (e.g., “+1234567890”).

​
lease.terminate(params)

​
number
string
required
The leased phone number to terminate, in E.164 format (e.g., “+1234567890”).

​
Using Leased Numbers

Once you have a leased number, you can use it as the from parameter in your messaging:
// Use leased number as sender for SMS
const res = await contiguity.text.send({
  to: "+1234567890",
  message: "Hello from your dedicated number!",
  from: "+15555555555" // your leased number
});

// Use leased number as sender for iMessage
const res = await contiguity.imessage.send({
  to: "+1234567890",
  message: "Hello via iMessage!",
  from: "+15555555555" // your leased number
});