Created API Status (markdown)

Lonami 2017-09-10 15:51:50 +02:00
parent b4780b61ef
commit 70e6bf4a24

27
API-Status.md Normal file

@ -0,0 +1,27 @@
In an attempt to help everyone who works with the Telegram API, the library will by default report all *Remote Procedure Call* errors to [RPC PWRTelegram](https://rpc.pwrtelegram.xyz/), a public database anyone can query, made by [Daniil](https://github.com/danog). All the information sent is a ``GET`` request with the error code, error message and method used.
If you still would like to opt out, simply set `client.session.report_errors = False` to disable this feature. However Daniil would really thank you if you helped him (and everyone) by keeping it on!
## Querying the API status
The API is accessed through `GET` requests, which can be made for instance through `curl`. A JSON response will be returned.
**Error codes for a specific request**:
```bash
curl https://rpc.pwrtelegram.xyz/?for=messages.sendMessage
```
**Number of `RPC_CALL_FAIL`'s**:
```bash
curl https://rpc.pwrtelegram.xyz/?rip # last hour
curl https://rpc.pwrtelegram.xyz/?rip=$(time()-60) # last minute
```
**Description of errors**:
```bash
curl https://rpc.pwrtelegram.xyz/?description_for=SESSION_REVOKED
```
**Code of a specific error**:
```bash
curl https://rpc.pwrtelegram.xyz/?code_for=STICKERSET_INVALID
```