Команда получает информацию обо всех активных чатах в данном клиенте. В ответе выдает список контактов клиента, включая группы, а также список участников групп с правами.

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

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

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

{
  "WhatsappID": "YOUR_WHATSAPP_ID"
}

• WhatsappID - идентификатор Whatsapp в системе

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

{
  "result": "OK",
  "data": [
    { ... CHAT_CONTACT_OBJECT ... }
    ...
  ]
}

data - поле data содержит массив объектов типа контакт чата или группа чата

{
  "id" : "[email protected]",
  "name" : "Василий",
  "isGroup" : false,
  "isReadOnly" : false,
  "unreadCount" : 0,
  "timestamp" : 1662710454,
  "pinned" : false,
  "isMuted" : false,
  "muteExpiration" : 0
}

• id - идентификатор контакта
• name - имя контакта
• isGroup - является ли группой, для контакта false
• isReadOnly - запрещена ли отправка сообщений данному получателю, true - запрещена, false - разрешена
• unreadCount - количество непрочитанных сообщений в данном чате
• timestamp - Время последней активности в данном чате в формате unix-timestamp
• pinned - является ли чат закрепленным, true - да, false - нет
• isMuted - отключены ли уведомления у данного чата, true - отключены, false - включены
• muteExpiration - время в секундах, через которое уведомления будут включены снова, если они отключены

{
  "id" : "[email protected]",
  "name" : "Тестовая",
  "isGroup" : true,
  "isReadOnly" : false,
  "unreadCount" : 0,
  "timestamp" : 1662616476,
  "pinned" : false,
  "isMuted" : false,
  "muteExpiration" : 0
  "groupMetadata" : {... GROUP_METADATA_OBJECT ...}
 }

• id - идентификатор группы
• name - имя группы
• isGroup - является ли группой, для группы true
• isReadOnly - запрещена ли отправка сообщений в данную группу, true - запрещена, false - разрешена
• unreadCount - количество непрочитанных сообщений в данной группе
• timestamp - Время последней активности в данной группе в формате unix-timestamp
• pinned - является ли группа закрепленной, true - да, false - нет
• isMuted - отключены ли уведомления в данной группе, true - отключены, false - включены
• muteExpiration - время в секундах, через которое уведомления будут включены снова, если они отключены
• groupMetadata - объект метаданных группы

{
  "id" : "[email protected]",
  "creation" : 1658328976,
  "owner" : "[email protected]",
  "size" : 3,
  "participants" : [
     { ... PARTICIPANT_OBJECT ...}
     ...
  ]
}
  
  

• id - идентификатор группы
• creation - дата создания группы в формате unix-timestamp
• owner - идентификатор владельца группы
• size - количество участников группы
• participants - массив объектов участников группы

{
  "id" : "[email protected]",
  "isAdmin" : true,
  "isSuperAdmin" : false
}

• id - идентификатор контакта участника группы
• isAdmin - является ли контакт администратором группы, true - да, false - нет
• isSuperAdmin - является ли контакт супер-администратором группы, true - да, false - нет

{
  "result":"OK",
  "data" : [
    { 
      "id" : "[email protected]", 
      "name" : "+7 999 999-99-99", 
      "isGroup" : false,
      "isReadOnly" : false,
      "unreadCount" : 0,
      "timestamp" : 1662710454,
      "pinned" : false,
      "isMuted" : false,
      "muteExpiration" : 0
    },
    {
      "id" : "[email protected]",
      "name" : "Тестовая",
      "isGroup" : true,
      "isReadOnly" : false,
      "unreadCount" : 0,
      "timestamp" : 1662616476,
      "pinned" : false,
      "isMuted" : false,
      "muteExpiration" : 0,
      "groupMetadata" : {
         "id" : "[email protected]",
         "creation" : 1658328976,
         "owner" : "[email protected]",
         "size" : 0,
         "participants" : [
           {
             "id" : "[email protected]",
             "isAdmin" : true,
             "isSuperAdmin" : false
           },
           { 
             "id" : "[email protected]",
             "isAdmin" : false,
             "isSuperAdmin":false
           }
        ]
      }
    }
  ]
}