Skip to main content

GetPoolStats returns overall statistics about the DID pool.

GET 

/api/v1/voice/admin/did-pool/stats

Returns counts of DIDs by status.

Response

  • total_count: Total DIDs in pool
  • available_count: DIDs ready for allocation
  • reserved_count: DIDs reserved (not for allocation)
  • allocated_count: DIDs currently allocated
  • pending_release_count: DIDs in grace period
  • retired_count: Retired DIDs

Errors

  • PERMISSION_DENIED: Caller lacks voice:admin permission

Responses

A successful response.