Accounts

Your sending limits and current usage

The daily cap (a rolling 24 hours), how much of it is used, the per-recipient cap, the probation status that gates "request a higher volume", any active pause, and your past requests. The top-level cap and usage are for sends from local numbers; toll_free holds the separate allowance for sends from toll-free numbers, which has no probation. number_queues shows each of your numbers' carrier queue: the parts a minute it sends, the parts waiting now, and when they should have gone out (an estimate).

Requires account:r.

get/v1/send-limit

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/send-limit
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Response

Sending limits, usage and past volume requests.

daily_limitinteger required

Live sends from local numbers allowed in a rolling 24 hours.

sent_last_24hinteger required
remaininginteger required
window_hoursinteger required
approved_daily_limitinteger required

The standard volume a request is granted by default.

probation_daysinteger required
recipient_rate_per_hourinteger required

Messages one recipient may receive from the account in an hour.

recipient_rate_per_dayinteger required

Messages one recipient may receive from the account in a day.

paused_untilstring date-time nullable required

Set while sending is paused.

pause_reasonstring nullable required

Why sending is paused: OPT_OUT_RATE, FAILURE_RATE or MANUAL.

Changes

No recorded changes to this operation across all 1 revision of this API.