Skip to content
Anatoly Zakharov edited this page Aug 22, 2018 · 34 revisions

Any Generic Request

{
  "id": 0, // required
  "action": "XXX" // required
}

INIT

Request

{
  "session_id": "XXX" // optional
}

Response

{
  "session_id": "XXX",
  "connection_id": "XXX",
  "expires_in": 172800
}

AUTH

After login button has been pressed and client pressed start in bot

Request

https://t.me/medev_bot?start=${connection_id}

Response

{
  "user_id": 123456789,
  "first_name": "XXX",
  "username": "@XXX",
  "language_code": "XXX",
  "photo": "XXX"
}

LOGOUT

Disassociate the session and telegram user

Request

{
  // only common fields
}

Response

{
  // empty object in case of success, error message if don't
}

GET_CATEGORIES

Get the list of available categories for channels

Request

{
  // only common fields
}

Response

{
  "categories": [
    {
      "id": 1,  // int, numeric ID of category, used in API requests
      "name": "XXX",  // str, name of category
    }
  ]
}

FETCH_CHANNELS

Request

{
  "count": 0, // optional
  "offset": 0, // optional
  "title": "XXX", // optional
  "category": "XXX", // optional
  "members": [0, 0], // optional, must be .length === 2
  "cost": [0, 0] // optional, must be .length === 2
  "likes": [0, 0] // optional, must be .length === 2
}

Response

{
  "data": {
    "items": [
      {
        "category": "XXX",
        "cost": 0,
        "description": "XXX",
        "id": 0,
        "language": "XXX",
        "members": 0,
        "members_growth": 0,
        "photo": "XXX",
        "telegram_id": -1,
        "title": "XXX",
        "username": "@XXX",
        "verified": true,
        "views": 0,
        "views_growth": 0,
        "vip": true,
        "likes": 0
      }
    ], // array of channels
    "total": 0,
    "max_members": 0,
    "max_cost": 0
    "max_likes": 0
  }
}

FETCH_CHANNEL

Request

{
  "username": "@XXX" // required
}

Response

{
  "data": {
    "channel": {
      "category": "XXX",
      "cost": 0,
      "description": "XXX",
      "id": 0,
      "language": "XXX",
      "members": 0,
      "members_growth": 0,
      "photo": "XXX",
      "telegram_id": -1,
      "title": "XXX",
      "username": "@XXX",
      "verified": true,
      "views": 0,
      "views_growth": 0,
      "vip": true,
      "likes": 0
    }
  }
}

VERIFY_CHANNEL

Request

{
  "username": "@XXX" // required
}

Response

{
  "is_admin": true
  OR
  "error": "XXX"
}

UPDATE_CHANNEL

Request

{
  "username": "@XXX" // required
}

Response

{
  "updated": true
  OR
  "error": "channel does not exist"
}

LIKE_CHANNEL

Request

{
  "username": "@XXX" // required
}

Response

{
  "liked": true
  OR
  "error": "XXX"
}

DISLIKE_CHANNEL

Request

{
  "username": "@XXX" // required
}

Response

{
  "disliked": true
  OR
  "error": "XXX"
}

Clone this wiki locally