Buy another phone number, in the US or abroad, paid from the balance at the carrier's own price (see call4me_list_numbers for prices). It renews from the balance every 30 days; if the balance can't cover a renewal the number is released after 7 days. Only buy when the user asks for a number or needs one to call a country. A number abroad is reviewed by the carrier after it's paid for, from minutes to a few days: it comes back pending, activates by itself, and can't place calls until then.

post/api/numbers

Request

  • Base URL: https://call4.me
  • URL: https://call4.me/api/numbers
  • Auth: HTTP bearer

Request body

countrystring required

ISO country code from the countries list, e.g. "NL", "GB", "CA", "US"

area_codestring

preferred area code (national destination code), e.g. "415" or "20"; the nearest available is used otherwise

Response

The number bought, ready to call from

numberstring required

formatted for people

e164string required
countrystring required

ISO 3166-1 alpha-2

country_namestring required
typestring required

local, mobile, national or toll_free

includedboolean required

the free number that came with the account

monthlystring required
monthly_centsinteger required
renewsstring nullable required

date the next monthly charge is due; null for the free number

overdueboolean required

the last renewal failed for lack of credits

release_afterstring nullable required

when an overdue number is released unless credits are added

Changes

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