Get Number Removal Status Summary

The Get Number Removal Status Summary request retrieves a summary of the removal status of all Operator Connect telephone numbers for monitoring and reporting purposes.

■

Request Handling Rules:

●

MarkedForRemoval status (value 2): Numbers identified as missing from OC acquired numbers list

●

ReadyForRemoval status (value 3): Numbers confirmed to be deleted and ready for final removal

●

TotalCounts represents the sum of MarkedForRemoval and ReadyForRemoval counts

●

When msTenantId is omitted, aggregates data across all tenants

■

Validation Rules:

●

msTenantId must be a valid GUID format when provided

●

Empty or null msTenantId is acceptable and returns global summary

URI

Copy

{{baseUrl}}/api/v3/oc/numbers/removal-status/summary

HTTP Method

GET

Request Parameters

Parameter	Type	Description
msTenantId	string	Customer's Microsoft Azure Tenant Subscription Id (GUID format) to filter numbers. This parameter is optional; if not provided, returns summary for all tenants.

Example Response

Copy

{
  "markedForRemovalCount": 15,
  "readyForRemovalCount": 8,
  "totalCounts": 23
}

HTTP Responses

■

200 OK

Parameter	Type	Description
markedForRemovalCount	integer	The count for numbers that have been marked for removal
readyForRemovalCount	integer	The count for numbers that are ready for removal.
totalCounts	integer	The total numbers count including those marked for removal and those ready for removal.

■

400 Bad Request

Parameter	Type	Description/Examples
errors	string	Text description of the error.
type	string	"https://tools.ietf.org/html/rfc7231#section-6.5.1"
title	string	Email title. For example "One or more validation errors occurred."
status	error code	HTML error code i.e. 400
detail	string	Additional error details.
traceId	string	Error trace Id
instance	string	Error instance
errorTicket	string	This field may not appear for all return codes.
errorCode	string	This field may not appear for all return codes.
additionalProp1	string	Custom Script variable argument. For example "CacProfile": "5 sessions"
additionalProp2	string	Custom Script argument. For example, ProxySet": "SIPTrunk"
additionalProp3	string	Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"

■

500 Internal Server Error