Информация о чатах
Команда получает информацию обо всех активных чатах в данном клиенте. В ответе выдает список контактов клиента, включая группы, а также список участников групп с правами.
Команда отправки
Для проверки номера инициируется POST-запрос на адрес:
https://whatsgate.ru/api/v1/get-chats
Объект в теле запроса
В теле запроса передается объект:
{ "WhatsappID": "YOUR_WHATSAPP_ID" }
- WhatsappID - идентификатор Whatsapp в системе
Объект ответа на запрос
Объект успешного ответа на запрос
{ "result": "OK", "data": [ { ... CHAT_CONTACT_OBJECT ... } ... ] }
data - поле data содержит массив объектов типа контакт чата или группа чата
Объект контакт чата
{ "id" : "79991112233@c.us", "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" : "4239048293082@g.us", "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" : "4239048293082@g.us", "creation" : 1658328976, "owner" : "79991112233@c.us", "size" : 3, "participants" : [ { ... PARTICIPANT_OBJECT ...} ... ] }
- id - идентификатор группы
- creation - дата создания группы в формате unix-timestamp
- owner - идентификатор владельца группы
- size - количество участников группы
- participants - массив объектов участников группы
Объект участник группы
{ "id" : "79156666555@c.us", "isAdmin" : true, "isSuperAdmin" : false }
- id - идентификатор контакта участника группы
- isAdmin - является ли контакт администратором группы, true - да, false - нет
- isSuperAdmin - является ли контакт супер-администратором группы, true - да, false - нет
Полный пример ответа
{ "result":"OK", "data" : [ { "id" : "79999999999@c.us", "name" : "+7 999 999-99-99", "isGroup" : false, "isReadOnly" : false, "unreadCount" : 0, "timestamp" : 1662710454, "pinned" : false, "isMuted" : false, "muteExpiration" : 0 }, { "id" : "4239048293082@g.us", "name" : "Тестовая", "isGroup" : true, "isReadOnly" : false, "unreadCount" : 0, "timestamp" : 1662616476, "pinned" : false, "isMuted" : false, "muteExpiration" : 0, "groupMetadata" : { "id" : "4239048293082@g.us", "creation" : 1658328976, "owner" : "79999999999@c.us", "size" : 0, "participants" : [ { "id" : "79999999999@c.us", "isAdmin" : true, "isSuperAdmin" : false }, { "id" : "79991112233@c.us", "isAdmin" : false, "isSuperAdmin":false } ] } } ] }