Numbers

Cancel a pool virtual number you own

Immediately cancels an active pool number owned by your account and returns it to the pool. No refund for the remaining period. Pool numbers only - a legacy third-party-provider number must be cancelled from the web Numbers page. If the number was bought with a callback URL, that URL receives a final form POST with event=cancelled and msisdn

post/cancel-number/

Request

  • Base URL: http://api.smsfusion.com.au
  • URL: http://api.smsfusion.com.au/cancel-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 cancelled and returned to the pool

successboolean
msisdnstring
statusstring
callbackboolean

Changes

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