Numbers

Release Phone Number

Permanently release a phone number that is not in use.

Destructive: unrents the number from the carrier. The number cannot be recovered, and calls and texts to it will stop. Refused while a call is in progress or a lease is still active.

Returns number_id, phone_number, status "released", released true and a warning. HTTP 409 if the number is not active, is on a call or has an active lease; HTTP 502 if the carrier refuses (the number stays active).

post/v1/numbers/{number_id}/release

Request

  • Base URL: https://api.agentline.cloud
  • URL: https://api.agentline.cloud/v1/numbers/{number_id}/release
  • Auth: HTTP bearer

Path parameters

number_idstring required

Phone number ID (num_...) from list_phone_numbers or buy_phone_number, not the phone number itself.

Response

Successful Response

unknown required

Changes

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