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.Parameters
No parameters required.Response
boolean
Indicates if there are numbers available for leasing.
object[]
Array of available phone numbers with their details.
object
Request metadata including ID, timestamp, and API version.
Get Number Details
Get detailed information about a specific phone number, including capabilities and pricing.Parameters
string
required
Phone number in E.164 format. First argument.
Response
object
Phone number details and formatting information.
string[]
Array of supported capabilities for this number (e.g., [“sms”, “voice”]).
object
Pricing information for leasing this number.
object
Request metadata including ID, timestamp, and API version.
Lease a Number
Create a lease for a phone number to use it as a sender.Parameters
string
required
Phone number in E.164 format. First argument.
object
Optional. e.g.
{ billing_method: "monthly" }.Response
string
Unique identifier for the created lease.
string
Current status of the lease (e.g., “active”, “pending”).
object
Billing information and configuration for the lease.
object
Request metadata including ID, timestamp, and API version.
View Leased Numbers
Get a list of all numbers you currently have leased.Parameters
No parameters required.Response
boolean
Indicates if any numbers are currently leased.
object[]
Array of currently leased phone numbers with their details.
object
Request metadata including ID, timestamp, and API version.
Get Lease Details
Get detailed information about a specific lease.Parameters
string
required
Leased phone number in E.164. First argument.
Response
string
Unique identifier for the lease.
string
Current status of the lease (e.g., “active”, “expired”, “terminated”).
object
Billing information and current charges for the lease.
object
Request metadata including ID, timestamp, and API version.
Configure a lease
Customize a leased number’s failover behavior.Parameters
string
required
Leased phone number in E.164 format.
object
required
Failover configuration.
Response
string
The configured number.
object
Applied failover config: enabled, mode, numbers.
object
Request metadata: id, timestamp, api_version, object.
Terminate a Lease
End a lease for a phone number when you no longer need it.Parameters
string
required
Leased phone number in E.164. First argument.
Response
string
Unique identifier for the terminated lease.
string
Confirmation status of the termination (e.g., “terminated”).
timestamp
ISO 8601 formatted timestamp of when the lease was terminated.
object
Request metadata including ID, timestamp, and API version.
Using Leased Numbers
Once you have a leased number, you can use it as thefrom parameter in your messaging:
