Numbers

Buy a virtual number from the platform pool

Leases an available pool number to your account, charges your pre-pay balance and starts the recurring renewal. The optional callback URL receives billing lifecycle events as form POSTs. Payloads: event=purchased carries msisdn, price (decimal string), duration (month|year), nextcharge (YYYY-MM-DD), sent on this purchase; event=renewed carries msisdn, price, nextcharge, sent after each successful renewal charge; event=renewal_failed carries msisdn, price, sent when the wallet cannot cover a renewal - top up promptly to keep the number; event=cancelled carries msisdn, sent when the number is cancelled from either /cancel-number/ or the web Numbers page

post/buy-number/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/buy-number/
  • Auth: one of:
    • API key in query parameter key
    • HTTP basic

Query parameters

keystring required

API Key as generated from the <a href='https://www.smsfusion.com.au/admin/api/'>admin panel</a>

Response

Number purchased and charged

successboolean
msisdnstring
pricestring

Decimal string, e.g. 9.95

durationstring
nextchargestring
callbackboolean

Changes

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