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:

●

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 database

●

Each number must currently have "MarkedForRemoval" status

■

Other rules:

●

This endpoint is subject to a global rate limit of 300 requests per minute.

●

Processing is performed sequentially for each number in the request.

●

If the client cancels the request during processing, a partial result are returned.

●

Large requests may take longer to process; consider dividing them into smaller batches.

●

Numbers that fail validation or status checks are included in the error details for troubleshooting.

URI

Copy

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

HTTP Method

POST

Request Body

Parameter

Mandatory

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 already exist in Live Platform database.

■

Each telephone number must be in "MarkedForRemoval" status to be cleared.

Phone number validation rules are in accordance with E.164 format:

■

A + sign.

■

Country calling code (international).

■

Local area code.

Local telephone number or subscriber number.

It has the following structure: [+][country code][area code][subscriber number].

Example of a number with E.164 format in the United States

Telephone number: 415 123 1234

E.164 format number: +14151231234

■

Country code: +1

■

Area code: 415

■

Subscriber number: 1231234

Valid country code, per civic address and/or contact info of the given lead. See Country Dialing Codes.

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

■

Partial Success Response (HTTP 409): Example:

Copy

{
  "title": "Conflict with Partial Success",
  "detail": "One or more numbers could not be processed. Successfully processed: 2 of 3 numbers.",
  "status": 409,
  "traceId": "0HMVP8H2N7QK1:00000001",
  "instance": "/api/v3.0/oc/numbers/action/clear-removal-status",
  "errorCode": "PARTIAL_SUCCESS_CONFLICT",
  "processedCount": 3,
  "totalCount": 3,
  "successCount": 2,
  "failedCount": 1,
  "successfulNumbers": ["+12345678901", "+12345678902"],
  "failedNumbers": [
    {
      "telephoneNumber": "+12345678903",
      "currentStatus": "Active",
      "errorType": "InvalidStatus",
      "message": "Number must be in MarkedForRemoval status"
    }
  ]
}