Skip to content

Latest commit

 

History

History
130 lines (107 loc) · 3.85 KB

File metadata and controls

130 lines (107 loc) · 3.85 KB

Создание комнаты

POST-запрос на /createRoom. Тело запроса имеест следующий вид:

{
    "room_name": "Имя комнаты",
    "owner_info": {
        "id": 100500,               // Тут id по которому идентифицируется юзер в боте
        "name": "Имя пользователя",
        "type": "vk"                // Или tg
    }
}

Ответ приходит в формате:

{
    "room_id": 42,      // Номер комнаты, -1 если ошибка
    "error": "Текст ошибки"
}

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

GET-запрос на /rooms?role=&userID=&botType=, где

  • role - роль для которой запрашивается список комнат
    • reader - список комнат, на которые подписан юзер
    • moderator - список комнат, в которые юзер может писать
    • admin - список комнат, в которых юзер является админом
  • userID - айди юзера, которое выдает апи
  • botType - тип бота, либо vk, либо tg

Возращается json формата:

{
   "rooms": [
       {
           "id": 42,   // ID комнаты
           "name": "Имя комнаты"
       },
       ...
   ],
   "error": "Текст ошибки, если ее нет, то вернется none"
}

Подписка на комнату

POST-запрос на /subscribe. Тело запроса

{
    "room_id": 42,       // ID комнаты, на которую надо подписаться
    "user_info": {
        "id": 100500,               // Тут id по которому идентифицируется юзер в боте
        "name": "Имя пользователя",
        "type": "vk"                // Или tg
    }
}

Тело ответа:

{
    "error": "Сообщение ошибки. none если все ок"
}

Отправка сообщения

POST-запрос на /sendMessage. Тело запроса

{
    "room_id": 42,                  // ID комнаты, в которую отправляются сообщения
    "message": "Текст сообщения",
    "sender_info": {                // Для проверки прав на отправку
        "id": 100500,               // Тут id по которому идентифицируется юзер в боте
        "name": "Имя пользователя",
        "type": "vk"                // Или tg
    }
}

Тело ответа:

{
    "error": "Сообщение ошибки. none если все ок"
}

Получение подробной информации о комнате

GET-запрос /roomInfo?id=100500

Тело ответа:

{
    "room_name": "Имя комнаты",
    "admin": {
        "id": 100500,               // Тут id по которому идентифицируется юзер в боте
        "name": "Имя пользователя",
        "type": "vk"                // Или tg
    },
    "moderators": [
        {
            "id": 100500,               // Тут id по которому идентифицируется юзер в боте
            "name": "Имя пользователя",
            "type": "vk"                // Или tg
        },
        ...
    ],
    "readers": [
        {
            "id": 100500,               // Тут id по которому идентифицируется юзер в боте
            "name": "Имя пользователя",
            "type": "vk"                // Или tg
        },
        ...
    ],
    "error": "Текст ошибки, none если все ок"
}