danog/TelegramApiServer
1
0
Fork 0
mirror of https://github.com/danog/TelegramApiServer.git synced 2024-11-26 20:04:45 +01:00
Code Issues Projects Releases Wiki Activity

Add custom methods list to readme

Browse Source
This commit is contained in:
Alexander Pankratov 2021-01-14 00:16:54 +03:00
parent 7c833ba904
commit 210762f9e0
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -273,9 +273,14 @@ Each session stored in `sessions/{$session}.madeline`. Nested folders supported.
* Session list: `http://127.0.0.1:9503/system/getSessionList` * Session list: `http://127.0.0.1:9503/system/getSessionList`
* Adding session: `http://127.0.0.1:9503/system/addSession?session=users/xtrime` * Adding session: `http://127.0.0.1:9503/system/addSession?session=users/xtrime`
* Removing session (session file will remain): `http://127.0.0.1:9503/system/removeSession?session=users/xtrime` * Removing session (session file will remain): `http://127.0.0.1:9503/system/removeSession?session=users/xtrime`
Due to madelineProto issue its instance still might be in memory and continue working even after the remove.
* Remove session file: `http://127.0.0.1:9503/system/unlinkSessionFile?session=users/xtrime` * Remove session file: `http://127.0.0.1:9503/system/unlinkSessionFile?session=users/xtrime`
Don`t forget to logout and call removeSession first! Don`t forget to logout and call removeSession first!
* Close TelegramApiServer (end process): `http://127.0.0.1:9503/system/exit`
Full list of system methods available in [SystemApiExtensions class](https://github.com/xtrime-ru/TelegramApiServer/blob/master/src/MadelineProtoExtensions/SystemApiExtensions.php)
### Authorizing session remotely
If there is no authorization in session, or session file is blank, authorization required: If there is no authorization in session, or session file is blank, authorization required:
User: User:
@ -289,6 +294,8 @@ Bot:
Save new session to file immediately: `http://127.0.0.1:9503/api/bot/serialize` Save new session to file immediately: `http://127.0.0.1:9503/api/bot/serialize`
Also, session can be authorized in cli/shell on server start.
### Websocket ### Websocket
#### EventHandler updates (webhooks). #### EventHandler updates (webhooks).
@ -318,6 +325,20 @@ PHP websocket client example: [websocket-events.php](https://github.com/xtrime-r
`php examples/websocket-events.php --url=ws://127.0.0.1:9503/log` `php examples/websocket-events.php --url=ws://127.0.0.1:9503/log`
### Custom methods
TelegramApiServer extends madelineProto with some handful methods.
Full list of custom methods and their parameters available in [ApiExtensions class](https://github.com/xtrime-ru/TelegramApiServer/blob/master/src/MadelineProtoExtensions/ApiExtensions.php#L19)
* `getHistory` - same as messages.getHistory, but all params exept peer is optional.
* `getHistoryHtml` - message entities converted to html
* `formatMessage` - converts entities to html
* `copyMessages` - copy message from one peer to onother. Like forwardMessages, but without the link to original.
* `getMedia` - download media to stream/browser
* `getMediaPreview` - download media preview to stream/browser
* `uploadMediaForm` - upload document from POST request.
## Contacts ## Contacts
* Telegram: * Telegram: