Sessions

Sessions

Sessions are WhatsApp identities managed by the ChatSend service. This section follows docs/api-spec-sessions.md.

Home/Docs/Sessions

Session Status

ValueMeaning
STARTINGSession is starting
CONNECTEDConnected to WhatsApp
STOPPEDStopped
QR_REQUIREDQR scan is required
ERRORError state

ChatSendSession

FieldTypeDescription
uniqueSessionIdstringSession unique identifier
sessionNamestringHuman-readable session name
phoneNumberstringAssociated phone number
statusstringCurrent status: STARTING, CONNECTED, STOPPED, QR_REQUIRED, or ERROR
createdAtstringISO 8601 creation timestamp
updatedAtstringISO 8601 last-update timestamp
JSON
{
  "uniqueSessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "sessionName": "Sales Primary",
  "phoneNumber": "+6281224560101",
  "status": "CONNECTED",
  "createdAt": "2026-04-10T12:00:00.000Z",
  "updatedAt": "2026-04-15T08:30:00.000Z"
}

SessionConfig

FieldTypeDescription
enableAccountProtectionboolean?Whether account protection is enabled
enableMessageLoggingboolean?Whether message logging is enabled
enableWebhookboolean?Whether webhook notifications are enabled
webhookUrlstring?Webhook callback URL