Back to top

API Documentation

Main

Handle Create Room

Handle Create Room
POST/createRoom

отвечает за обработку запроса на создание комнаты

Example URI

POST /createRoom
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "owner_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  },
  "room_name": "test room name"
}
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "room_id": 1,
  "error": "none"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "room_name": "test room name",
  "user_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  }
}
Response  400
HideShow
Body
{
  "room_id": -1,
  "error": "Bad request body, check api docs"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "owner_info": {
    "id": "1337",
    "name": "Test Name",
    "type": "tg"
  },
  "room_name": "test room name"
}
Response  400
HideShow
Body
{
  "room_id": -1,
  "error": "Bad values in request body"
}

Handle Get Full Room Info

Handle Get Full Room Info
GET/roomInfo{?id}

Example URI

GET /roomInfo?id=1
URI Parameters
HideShow
id
number (required) Example: 1
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "room_name": "test room name",
  "admin": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  },
  "moderators": null,
  "reader": [
    {
      "id": 100500,
      "name": "Test Subscriber",
      "type": "vk"
    }
  ],
  "error": "none"
}
Response  400
HideShow
Body
{
  "room_name": "",
  "admin": {
    "id": 0,
    "name": "",
    "type": ""
  },
  "moderators": null,
  "reader": null,
  "error": "Bad values in request query"
}

Handle Get Rooms

Handle Get Rooms
GET/rooms{?botType,role,userID}

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

Example URI

GET /rooms?botType=vk&role=reader&userID=100500
URI Parameters
HideShow
botType
string (required) Example: vk
role
string (required) Example: reader
userID
number (required) Example: 100500
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "rooms": [
    {
      "id": 1,
      "name": "test room name"
    }
  ],
  "error": "none"
}

Handle Get Rooms

Handle Get Rooms
GET/rooms{?role,userID,botType}

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

Example URI

GET /rooms?role=admin&userID=1337&botType=tg
URI Parameters
HideShow
role
string (required) Example: admin
userID
number (required) Example: 1337
botType
string (required) Example: tg
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "rooms": [
    {
      "id": 1,
      "name": "test room name"
    }
  ],
  "error": "none"
}
Response  400
HideShow
Body
{
  "rooms": null,
  "error": "Bad values in request query"
}

Hande Send Message

Hande Send Message
POST/sendMessage

обрабатывает запрос на оправку сообщений

Example URI

POST /sendMessage
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "test message",
  "room_id": 1,
  "sender_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  }
}
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "error": "none"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "test message",
  "room_id": 1,
  "sender_info": {
    "id": 100500,
    "name": "Test Subscriber",
    "type": "vk"
  }
}
Response  400
HideShow
Body
{
  "error": "You have no rights for sending message to this room"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "message": "test message",
  "room_id": "1",
  "sender_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  }
}
Response  400
HideShow
Body
{
  "error": "Bad values in request body"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "message": null,
  "room_id": 1,
  "sender_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  }
}
Response  400
HideShow
Body
{
  "error": "Bad request body, check api docs"
}

Hande New Subscribe

Hande New Subscribe
POST/subscribe

обрабатывает запрос на подписку юзера на комнату

Example URI

POST /subscribe
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "room_id": 1,
  "user_info": {
    "id": 100500,
    "name": "Test Subscriber",
    "type": "vk"
  }
}
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "error": "none"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "room_id": 1,
  "user_info": {
    "id": 1337,
    "name": "Test Name",
    "type": "tg"
  }
}
Response  200
HideShow
Headers
Content-Type: text/plain; charset=utf-8
Body
{
  "error": "You are admin of this room"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "info": {
    "id": 100500,
    "name": "Test Subscriber",
    "type": "vk"
  },
  "room_id": 1
}
Response  400
HideShow
Body
{
  "error": "Bad request body, check api docs"
}
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "room_id": 1,
  "user_info": {
    "id": "100500",
    "name": "Test Subscriber",
    "type": "vk"
  }
}
Response  400
HideShow
Body
{
  "error": "Bad values in request body"
}

Generated by aglio on 23 Apr 2018