Messenger

安装

源码

cd messenger
sh build.sh
cp conf/confTemplate.yaml conf/conf.yaml # edit your config
./messenger

docker

# 源码构建
cd messenger
cp conf/confTemplate.yaml conf/conf.yaml # edit your config
docker build --tag messenger .
docker run -d --name messenger -p 8888:8888 -v $(pwd)/conf:/messenger/conf --restart=always messenger
# 镜像
docker pull registry.cn-hangzhou.aliyuncs.com/veops/messenger:latest

API

发送消息

// 正常 httpStatusCode==200
{
 "msg": "ok"
}
// 异常 httpStatusCode!=200
{
 "msg": "xxxx"
}

curl

curl -X POST \
 'http://localhost:8888/v1/message' \
 --header 'Content-Type: application/json' \
 --data-raw '{
 "sender": "yourSenderName",
 "msgtype": "text",
 "content": "{\"content\":\"一行文本内容\"}"
}'

python

import json
import requests
reqUrl = "http://localhost:8888/v1/message"
response = requests.post(reqUrl, json={
 "sender": "yourSenderName",
 "msgtype": "text",
 "content": json.dumps({
 "content": "一行文本内容1"
 })
})
print(response.status_code)

golang

package main
import (
	"fmt"
	"github.com/go-resty/resty/v2"
)
func main() {
	reqUrl := "http://localhost:8888/v1/message"
	content, _ := json.Marshal(map[string]any{
		"content": "一行文本内容2",
	})
	resp, err := resty.New().R().
		SetBody(map[string]any{
			"sender": "yourSenderName",
			"msgtype": "text",
			"content": string(content),
		}).Post(reqUrl)
	fmt.Println(err, resp.StatusCode())
}

更新配置

// 正常 httpStatusCode==200
{
 "msg": "ok"
}
// 异常 httpStatusCode!=200
{
 "msg": "xxxx"
}

查询用户ID

// 正常 httpStatusCode==200
{
 "uid": "xxxxxxxxxxxxx",
 "msg": "ok"
}
// 异常 httpStatusCode!=200
{
 "msg": "xxxx"
}

查询消息历史

// 正常 httpStatusCode==200
{
 "count": 1,
 "list": [
 {
 "CreatedAt": 1705911411,
 "Err": "",
 "Id": 1,
 "Message": "json string of message",
 "ReceivedAt": 1705911410,
 "Req": "curl command of request",
 "Resp": "json string of response body and http code",
 "Status": true
 }
 ],
 "msg": "ok"
}
// 异常 httpStatusCode!=200
{
 "msg": "xxxx"
}

鉴权

IP

token

sign

// golang 签名示例
secret := "666"
body := map[string]any{
"sender": "wechatBot",
"msgtype": "text",
"content": "{\"content\":\"一行文本内容\"}",
}
body["ts"] = "1695005697" // cast.ToString(time.Now().Unix())
body["nonce"] = "123"
keys := lo.Keys(body)
sort.Strings(keys)
// content{"content":"一行文本内容"}msgtypetextnonce123senderwechatBotts1695005697
kvStr := strings.Join(lo.Map(keys, func(k string, _ int) string { return fmt.Sprintf("%s%s", k, body[k]) }), "")
mac := hmac.New(sha256.New, []byte(secret))
_, _ = mac.Write([]byte(kvStr))
// nAW4/1vz8EjdJEVXqTevmX7yBOzQtUti1Z2TIgAxogc=
sign := base64.StdEncoding.EncodeToString(mac.Sum(nil))

配置说明

app:
 ip:
 port: 8888
auths:
 # - type: ip
 # pattern: 192.168.*.*
 # - type: token
 # token: your token
 # - type: sign
 # secret: your secret
senders:
 email:
 # - name: yourSenderName1
 # host: mail.xxx.com
 # port: 25
 # account: test@xxx.com
 # password: #无密码时留空即可
 # tls: "false"
 wechatBot:
 # - name: yourSenderName2
 # url: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxx
 wechatApp:
 # - name: yourSenderName3
 # corpid: xxxx
 # agentid: xxxx
 # corpsecret: xxxx
 feishuBot:
 # - name: yourSenderName4
 # url: https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxx
 feishuApp:
 # - name: yourSenderName5
 # app_id: cli_xxxx
 # app_secret: xxxx
 dingdingBot:
 # - name: yourSenderName6
 # url: https://oapi.dingding.com/robot/send?access_token=xxxx
 # token: xxxx #仅加密方式为加签时填写
 dingdingApp:
 # - name: yourSenderName7
 # appKey: xxxx
 # appSecret: xxxx
 # robotCode: xxxx
 aliSms:
 # - name: yourSenderName8
 # accessKey: xxxx
 # accessSecret: xxxx
 # templateCode: SMS_123456789
 # signName: xxxx

自定义发送

Web