Получение списка сессий

Команда необходима, чтобы получить список сессий для аккаунта.

Команда отправки

Для получения списка сессий инициируется POST-запрос на адрес: 

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

Объект в теле запроса

В теле запроса передается объект: 

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

все указанные поля в данном объекте являются необязательными, т.е. для получения полного списка активных сессий достаточно передать пустой объект. Поля WhatsappID, name и status - являются фильтрами.

  • WhatsappID - фильтр по идентификатору WhatsApp, используется для точного совпадения и возвращает в результате одну сессию с указанным идентификатором.
  • name - фильтр по наименованию, срабатывает по неточному совпадению, т.е. по части вхождения строки.
  • status - фильтр по статусу сессии. Может принимать одно из указанных значений:
    • AUTH - сессии в статусе авторизации.
    • READY - сессии в рабочем состоянии.
    • ERROR - сессии в статусе ошибки.
    • CLOSED - закрытые сессии (по причине ошибки или по причине окончания оплаты по тарифу)
  • page_cnt - максимальное количество сессий, возвращаемых на одной странице запроса. По умолчанию - 50, максимальное значение - 100.
  • page - номер страницы запроса. По умолчанию - 1

Объект ответа на запрос

Объект успешного ответа на запрос 

{
  "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": "Авторизация",
        "pushname": null,
        "wid": null,
        "qr_link": "https://whatsgate.ru/qr/6345454545454"
     },
     {
        "id": 152,
        "name": "My WhatsApp 2",
        "unique_id": "6345454545455",
        "status": "READY",
        "callback": "",
        "date_add": "2022-10-12 10:35:01",
        "status_name": "Работает",
        "pushname": "Vasya",
        "wid": "79991234567@c.us",
        "qr_link": ""
     },
  ]
}
  • result - при успешном выполнении запроса содержит «OK»
  • pages - количество страниц при указанных фильтрах
  • elements - количество элементов в результате при указанных фильтрах (количество сессий WhatsApp в результате запроса)
  • page - номер текущей страницы
  • data - содержит массив объектов, представляющих сессию WhatsApp