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": 0,
  "readyForRemovalCount": 0,
  "totalCount": 0
}

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
type	string	Error type
title	string	Invalid msTenantId
status	string	StatusCodes.Status400BadRequest
detail	string	msTenantId has not a Guid format
Instance	string	HttpContext.Request.Path
errorTicket	string	The error ticket string opened for this request.
errorCode	string	Error code output in the request
TraceId	string	HttpContext.TraceIdentifier
additionalProp1	string	TBD
additionalProp2	string	TBD
additionalProp3	string	TBD

■

500 Internal Server Error

Parameter	Type	Description
type	string	Error type
title	string	Invalid msTenantId
status	string	StatusCodes.Status400BadRequest
detail	string	msTenantId has not a Guid format
Instance	string	HttpContext.Request.Path
errorTicket	string	ErrorTicket = errId.ToString()
errorCode	string	Error code output in the request
TraceId	string	HttpContext.TraceIdentifier
additionalProp1	string	TBD
additionalProp2	string	TBD
additionalProp3	string	TBD