Go to file
2019-01-21 22:37:24 +03:00
src Update for use in external projects via composer. 2019-01-21 22:37:24 +03:00
.env.example Direct Api access. 2019-01-20 20:20:41 +03:00
.gitignore Add composer.json and .gitignore 2018-12-24 15:34:04 +03:00
bootstrap.php Update for use in external projects via composer. 2019-01-21 22:37:24 +03:00
composer.json Basic functions: 2019-01-07 15:24:29 +03:00
config.php Direct Api access. 2019-01-20 20:20:41 +03:00
LICENSE Initial commit 2018-12-24 14:48:21 +03:00
README.md Direct Api access. 2019-01-20 20:25:58 +03:00
server.php Update for use in external projects via composer. 2019-01-21 22:37:24 +03:00

TelegramSwooleClient

Fast, simple, async php telegram client and parser: MadelineProto + Swoole Server

Features

  • Fast async swoole server
  • Use as micro-service to access telegram api
  • Get any public telegram posts from groups as json

TODO

  • RSS output
  • flood protection (for use in public)
  • logging

Installation

  1. Get app_id and app_hash at my.telegram.org

  2. Swoole extension required: Install swoole

  3. Install this package:

    a. Standalone:

    1. download files from github and extract.
    2. Run composer install inside unpacked directory

    b. Existing project:

    1. Add following into your project's composer.json
    "repositories": [
        {
           "type": "git",
           "url": "https://github.com/xtrime-ru/TelegramSwooleClient.git"
        }
    ],
    "require": {
        "xtrime-ru/telegramswooleclient": "dev-master",
    }
    

Usage

  1. Install

  2. Fill options in .env file (see .env.example)

  3. Run server/parser

    php server.php [--help] [-a|--address=127.0.0.1] [-p|--port=9503]
    
    Options:
    
            --help      Show this message
        -a  --address   Server ip (optional) (example: 127.0.0.1 or 0.0.0.0 to listen all hosts)
        -p  --port      Server port (optional) (example: 9503)
    
    Also all options can be set in .env file (see .env.example)
    
  4. Get posts from any open channel

    • Get 10 latests posts from any open channel via GET request: http://%address%:%port%/json/%channel% Example: http://127.0.0.1:9503/json/breakingmash

    • Get posts from multiple channels via POST:

      Url: http://127.0.0.1:9503/json/

      Headers: Content-Type: application/json

      form-data and x-www-form-urlencoded should work, but was not tested

      Body:

      {
         	"getHistory": [
         		{
         		    "peer":"channel#1259060275"
         		}, 
         		{
         		    "peer": "breakingmash",
         		    "limit": 30,
                  "max_id": 200,
         		}
         	]
      
         }
      

      You can use any other options from https://docs.madelineproto.xyz/API_docs/methods/messages_getHistory.html peer name can be provided in different formats: https://docs.madelineproto.xyz/API_docs/types/InputPeer.html

  5. Access telegram api directly via simple get requests.

    • Url: http://%address%:%port%/api/%method%/?%param1%=%val%
    • All available methods you can find in src/Client.php.
    • Important: All parameters must be passed at strict order!
    • Important: api available only from ip in whitelist. By default it is: 127.0.0.1 You can add client ip in .env file to API_CLIENT_WHITELIST (use json format)

    Examples:

    • get_info about channel/user: http://127.0.0.1:9503/api/getInfo/?id=@xtrime
    • repost: http://127.0.0.1:9503/api/forwardMessages/?fromPeer=@xtrime&toPeer=@xtrime&messageId=1234
    • get messages from channel/user: http://127.0.0.1:9503/api/getHistory/?data[peer]=@breakingmash&data[limit]=10
    • search: http://127.0.0.1:9503/api/searchGlobal/?q=Hello%20World&limit=10
    • sendMessage: http://127.0.0.1:9503/api/sendMessage/?data[peer]=@xtrime&data[message]=Hello!

Contacts

  • Telegram: @xtrime
  • Email: alexander(at)i-c-a.su