Sign in
🖥️ Sessions

Fetch the account reachout timelock state

Fetch a fresh reachout timelock state from WhatsApp - the restriction behind "server returned error 463" when messaging new contacts. The same value is also available under me.reachoutTimelock in the session info, and changes are pushed through the session.status event.

get/api/sessions/{session}/timelock

Request

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

Path parameters

sessionstring required

Session name

Response

enforcementType'DEFAULT' | 'BIZ_QUALITY' | 'BIZ_COMMERCE_VIOLATION_ADULT' | 'BIZ_COMMERCE_VIOLATION_ALCOHOL' | 'BIZ_COMMERCE_VIOLATION_ANIMALS' | 'BIZ_COMMERCE_VIOLATION_BODY_PARTS_FLUIDS' | 'BIZ_COMMERCE_VIOLATION_DATING' | 'BIZ_COMMERCE_VIOLATION_DIGITAL_SERVICES_PRODUCTS' | 'BIZ_COMMERCE_VIOLATION_DRUGS' | 'BIZ_COMMERCE_VIOLATION_DRUGS_ONLY_OTC' | 'BIZ_COMMERCE_VIOLATION_GAMBLING' | 'BIZ_COMMERCE_VIOLATION_HEALTHCARE' | 'BIZ_COMMERCE_VIOLATION_REAL_FAKE_CURRENCY' | 'BIZ_COMMERCE_VIOLATION_SUPPLEMENTS' | 'BIZ_COMMERCE_VIOLATION_TOBACCO' | 'BIZ_COMMERCE_VIOLATION_VIOLENT_CONTENT' | 'BIZ_COMMERCE_VIOLATION_WEAPONS' | 'WEB_COMPANION_ONLY' | 'RESTRICT_ALL_COMPANIONS' required

Raw WhatsApp enforcement type. Informational only - it does not change what is blocked. WhatsApp may introduce new values, so treat it as an open set.

isActiveboolean required
timeEnforcementEndsnumber nullable required

Unix timestamp (seconds) when the enforcement ends.

Example response

{
  "enforcementType": "RESTRICT_ALL_COMPANIONS",
  "isActive": true,
  "timeEnforcementEnds": 1784477333
}

Changes

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