numbers

Provision a phone number

post/numbers

Request

Base URL: https://api.saperly.com
URL: https://api.saperly.com/numbers
Auth: none required

Request body

countrystring nullable

ISO 3166-1 alpha-2 country code to provision a number in (e.g. US, GB). Defaults to US.

numberTypestring nullable

The kind of number to provision (e.g. local, toll_free, mobile, national). Defaults to local.

areaCodestring nullable

Preferred area code / city prefix to search within the country (e.g. 415). Omit to take any available number.

expectedMonthlyPriceCentsnumber nullable

The monthly price (in cents) you quoted to the customer. If the live order price exceeds it, provision fails with PriceChanged instead of charging — resubmit with approveHigherPrice: true to accept the higher price.

expectedUpfrontPriceCentsnumber nullable

The one-time upfront price (in cents) you quoted to the customer. If the live order price exceeds it, provision fails with PriceChanged instead of charging — resubmit with approveHigherPrice: true to accept the higher price.

approveHigherPriceboolean nullable

Set true to accept a live order price higher than the expected* values you quoted, instead of failing with PriceChanged.

Response

Success

idstring required

phoneNumberstring required

connectionIdstring nullable required

webhookUrlstring nullable required

smsSenderIdstring nullable

callerIdNamestring nullable

countrystring nullable required

numberTypestring nullable required

monthlyPriceCentsnumber nullable required

currencystring nullable required

nextChargeAtstring nullable required

releasedAtstring nullable required

createdAtstring required

Changes

No recorded changes to this operation across all 1 revision of this API.