Tally Voice

Get firm Tally voice usage telemetry

Returns non-blocking Eastern-calendar-month voice usage telemetry for the authenticated firm. Caps are not enforced.

get/tally/voice/usage

Request

  • Base URL: https://ledgerhq.pro/api/v1
  • URL: https://ledgerhq.pro/api/v1/tally/voice/usage
  • Auth: one of:
    • HTTP bearer and API key in header x-organization-id
    • HTTP bearer and API key in header x-organization-id

Response

Tally voice usage

enabledboolean required
unlimitedboolean

When true, remainingSeconds is null and caps are not enforced.

periodKeystring required

Eastern Time calendar month.

includedSecondsinteger required
purchasedSecondsinteger required
allowanceSecondsinteger required
usedMillisecondsinteger required
reservedMillisecondsinteger required
remainingSecondsinteger nullable
percentUsednumber required
warningLevel'none' | 'warning' | 'near_cap' | 'capped' required
maxSessionSecondsinteger required

Changes

No recorded changes to this operation across all 5 revisions of this API.