Sign in
🖥️ Sessions

Fetch the account new-chat message capping (per-cycle quota)

Fetch a fresh new-chat message capping (quota) state from WhatsApp. The same value is also available under me.messageCapping in the session info, and changes are pushed through the session.status event.

get/api/sessions/{session}/capping

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/sessions/{session}/capping
  • Auth: API key in header X-Api-Key

Path parameters

sessionstring required

Session name

Response

cappingStatus'NONE' | 'FIRST_WARNING' | 'SECOND_WARNING' | 'CAPPED' required

How close the account is to its new-chat quota. CAPPED means new chats are blocked. WhatsApp may introduce new values, so treat it as an open set.

totalQuotanumber required

New-chat messages allowed in the current cycle. -1 when the account has no cap.

usedQuotanumber required

New-chat messages already used in the current cycle.

cycleStartnumber nullable required

Unix timestamp (seconds) when the current cycle started.

cycleEndnumber nullable required

Unix timestamp (seconds) when the current cycle ends.

mvStatusstring nullable required

Meta Verified status. Informational.

oteStatusstring nullable required

One-time engagement status. Informational.

Example response

{
  "cappingStatus": "FIRST_WARNING",
  "totalQuota": 1000,
  "usedQuota": 640,
  "cycleStart": 1782874800,
  "cycleEnd": 1785553199,
  "mvStatus": "NOT_ELIGIBLE",
  "oteStatus": "NOT_ELIGIBLE"
}

Changes

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