Numbers

Release a test number

Test mode only. Removes a test number from the test project, so you can take another one (a test project has at most 3). Its call plan is removed with it; calls and messages are kept. A live key gets 409 number_release_not_supported: releasing a live number cancels it at the carrier for good and is not possible through the API.

delete/numbers/{id}

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/numbers/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: numbers:write)

Path parameters

idstring uuid required

The id of the number.

Response

The test number was released.

idstring uuid required

The id of the number that was released.

e164string required

The number in E.164, like +447700900123.

releasedtrue required

Always true: the number is no longer in the project.

testtrue required

Always true: only test numbers can be released through the API.

Changes

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