Getting the session list

This command is used to get the list of sessions for an account.

To retrieve the session list, send a POST request to:

https://whatsgate.org/api/v1/sessions-get

The request body accepts:

{
  "WhatsappID" : "",
  "name" : "",
  "status" : "",
  "page_cnt" : "",
  "page" : ""
}

All fields in this object are optional, so an empty object is enough to get the full list of active sessions. Fields WhatsappID, name, and status are filters.

• WhatsappID - filter by WhatsApp identifier, exact match; returns one session with the specified identifier.
• name - filter by name, partial match.
• status - session status filter. Can be one of:
  • AUTH - sessions in authorization status.
  • READY - sessions in working state.
  • ERROR - sessions in error state.
  • CLOSED - closed sessions (due to error or end of paid period)
• page_cnt - maximum sessions returned per page. Default is 50, maximum is 100.
• page - page number. Default is 1

Successful response object

{
  "result": "OK",
  "pages" : 1,
  "elements" : 2,
  "page" : 1,
  "data" : [
     {
        "id": 151,
        "name": "My WhatsApp 1",
        "unique_id": "6345454545454",
        "status": "AUTH",
        "callback": "",
        "date_add": "2022-10-11 19:30:14",
        "status_name": "Authorization",
        "pushname": null,
        "wid": null,
        "qr_link": "https://whatsgate.org/qr/6345454545454"
     },
     {
        "id": 152,
        "name": "My WhatsApp 2",
        "unique_id": "6345454545455",
        "status": "READY",
        "callback": "",
        "date_add": "2022-10-12 10:35:01",
        "status_name": "Working",
        "pushname": "Vasya",
        "wid": "79991234567@c.us",
        "qr_link": ""
     },
  ]
}

• result - contains “OK” when the request succeeds
• pages - number of pages for the selected filters
• elements - number of elements in the filtered result (number of WhatsApp sessions returned)
• page - current page number
• data - contains an array of WhatsApp session objects