Phone Numbers

Delete Phone Number

Deletes a workspace phone number, releases its provider rental or SIP connection, unlinks it from its agents, and prevents future DialNexa routing. The request is blocked if the number is a system default, has live calls, is used by a batch that is running, paused, scheduled or waiting, or is used by an active workflow. If the provider rental or SIP trunk cannot be released, the request fails with 502 and the number is kept.

delete/v1/organization-phone-numbers/{id}

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/organization-phone-numbers/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:phn_mfk3p8z2c4v6bn

Phone number ID

Response

Phone number deleted successfully. data is the number 200.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
data200 required
timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Success"
}

Changes

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