Clear Number Removal Status

The Clear Number Removal Status request clears the removal status from Operator Connect telephone numbers that are currently in "MarkedForRemoval" status, returning them to "Active" status. Only numbers currently in "MarkedForRemoval" status can be cleared through this API.

Numbers in "ReadyForRemoval" status cannot be cleared through this API.

■

Request handling rules:

●

Only telephone numbers in "MarkedForRemoval" status can be cleared

●

Numbers in "ReadyForRemoval" status cannot be cleared through this API

●

Successfully cleared numbers will be returned to "Active" status

●

Each number must exist in Live Platform and be associated with an Operator Connect customer

■

Number Validation rules:

●

Request body cannot be null

●

TelephoneNumbers array must contain between 1 and 500 numbers

●

Each telephone number must be in valid E.164 format (see below)

●

Each number must exist in the Live Platform Acquired Numbers database

●

Each number must currently be in "MarkedForRemoval" status

URI

Copy

{{baseUrl}}/api/v3/oc/action/clear-removal-status

HTTP Method

POST

Request Body

Parameter

Type

Description

telephoneNumbers

array of strings

Lists telephone numbers to clear removal 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 cleared.

Example Request Body

Copy

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

Example Response

Copy

{
  "data": {
    "processedCount": 1
  },
  "status": "success",
  "succeeded": true,
  "message": "Removal status successfully cleared for all numbers"
}

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 "Active".