1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
# Kimikuri: a message push bot
Kimikuri is a telegram bot which provides every Telegram user a unique token, and an HTTP API which enables them to push
messages to their Telegram. Originally this project was created to replace *ServerChan (方糖)*, which is mainly restricted
by WeChat's poor functionality.
[GitHub](https://github.com/keuin/kimikuri_rs) [Website](https://kimikuri.keuin.cc/)
# Usage
1. Start a conversation with [Kimikuri_yourbot](https://t.me/Kimikuri_yourbot).
2. Send a `/start` to obtain a token.
3. Push messages to your Telegram using our HTTP API.
## HTTP API
### Using POST (Recommended)
- Url: `https://kimikuri.keuin.cc/api/message`
- Method: `POST`
- Content-Type: `application/json`
- Request Body:
```json
{
"token": "<your token>",
"message": "<message>"
}
```
- Response:
+ Status Code: `200` (If the request is a valid JSON POST), `other` (If not)
+ Content-Type: `application/json`
+ Body:
- Success:
```json
{
"success": true,
"message": ""
}
```
- Fail:
```json
{
"success": false,
"message": "Invalid token."
}
```
### Using GET (Deprecated, kept for backward compatibility)
- Url: `https://kimikuri.keuin.cc/api/message`
- Method: `GET`
- Url Parameters:
+ `token`: Your token
+ `message`: Text message
- Response: Same to POST requests
Note: To prevent potential cache on the network, add a nonce parameter (such as a timestamp) if necessary.
## API Example
Here is an example in Python, using `requests`
```python
import requests
def send_message(token: str, message: str):
r = requests.post(
'https://kimikuri.keuin.cc/api/message',
json={
'token': token,
'message': message,
}
)
return r.ok and r.json().get('success')
if __name__ == '__main__':
send_message('<your token>', 'Hello, world!')
```
If you wish a unix tool instead, use the bash script below:
```shell
#!/bin/bash
# Disable globbing (expanding '*'), prevent some leaking exploits for security
set -f
TOKEN='<your API token>'
# Replace newline with '\\n', using a bash extension
MESSAGE="${1//$'\n'/\\n}"
# Escape '"' (JSON)
MESSAGE="${MESSAGE//\"/\\\"}"
if [ -z "$MESSAGE" ]
then
# Telegram API refuses to send empty string, so we print a help message instead.
echo "Usage: $0 <message>"
exit
fi
#echo "$MESSAGE"
curl -X POST https://kimikuri.keuin.cc/api/message \
-H 'Content-Type: application/json' \
--data "{\"token\":\"$TOKEN\",\"message\":\"$MESSAGE\"}" \
--connect-timeout 10 --retry 3
```
This script requires [cURL](https://curl.se/), which is shipped with almost all linux distros by default.
Place your API token in `$TOKEN`, then execute the script like this:
```shell
./kimikuri.sh "Hello, world!"
```
|