Transition Number to Ready for Removal

The Transition Number to Ready for Removal request transitions Operator Connect telephone numbers from "MarkedForRemoval" to "ReadyForRemoval", preparing them for the final removal process.

URI

Copy

{{baseUrl}}/api/v3/oc/numbers/action/ready-for-removal

HTTP Method

POST

Request Body

Parameter

Type

Description

telephoneNumbers

array of strings

Lists telephone numbers to transition to "ReadyForRemoval" status.

Note:

■

The array must not exceed 500 telephone numbers in a single request.

■

Each telephone number must be a valid format according to E.164 standards.

■

Each telephone number must exist in the system.

■

Each telephone number must be in "MarkedForRemoval" status to be transitioned to “ReadyForRemoval“.

Example Request Body

Copy

{
  "telephoneNumbers": [
    "+14255551212",
    "+14255551213"
  ]
}

Example Response

Copy

{
  "data": {
    "processedCount": 10
  },
  "status": "success",
  "succeeded": true,
  "message": "Numbers successfully transitioned to ReadyForRemoval status"
}

HTTP Responses

■

200 OK

Parameter	Type	Description
processedCount	integer	The total number of telephone numbers that were included in the request and processed by the system, regardless of the outcome (success or failure).
successCount	integer	The total number of telephone numbers that were successfully changed from "MarkedForRemoval" to “ReadyForRemoval“.