github/openwechat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[doc]: update docs (#214)

Browse Source
This commit is contained in:
多吃点苹果 2023-01-24 21:44:35 +08:00 committed by GitHub
parent 2d11a7b95a
commit b9bbaed369
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 67 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -4,16 +4,16 @@
[![Go Doc](https://pkg.go.dev/badge/github.com/eatMoreApple/openwechat)](https://godoc.org/github.com/eatMoreApple/openwechat)[![Release](https://img.shields.io/github/v/release/eatmoreapple/openwechat.svg?style=flat-square)](https://github.com/eatmoreapple/openwechat/releases)[![Go Report Card](https://goreportcard.com/badge/github.com/eatmoreapple/openwechat)](https://goreportcard.com/badge/github.com/eatmoreapple/openwechat)[![Stars](https://img.shields.io/github/stars/eatmoreapple/openwechat.svg?style=flat-square)](https://img.shields.io/github/stars/eatmoreapple/openwechat.svg?style=flat-square)[![Forks](https://img.shields.io/github/forks/eatmoreapple/openwechat.svg?style=flat-square)](https://img.shields.io/github/forks/eatmoreapple/openwechat.svg?style=flat-square) [![Go Doc](https://pkg.go.dev/badge/github.com/eatMoreApple/openwechat)](https://godoc.org/github.com/eatMoreApple/openwechat)[![Release](https://img.shields.io/github/v/release/eatmoreapple/openwechat.svg?style=flat-square)](https://github.com/eatmoreapple/openwechat/releases)[![Go Report Card](https://goreportcard.com/badge/github.com/eatmoreapple/openwechat)](https://goreportcard.com/badge/github.com/eatmoreapple/openwechat)[![Stars](https://img.shields.io/github/stars/eatmoreapple/openwechat.svg?style=flat-square)](https://img.shields.io/github/stars/eatmoreapple/openwechat.svg?style=flat-square)[![Forks](https://img.shields.io/github/forks/eatmoreapple/openwechat.svg?style=flat-square)](https://img.shields.io/github/forks/eatmoreapple/openwechat.svg?style=flat-square)
> golang版个人微信号API, 突破网页版限制，类似开发公众号一样，开发个人微信号 > golang版个人微信号API, 突破登录限制，类似开发公众号一样，开发个人微信号
微信机器人:smiling_imp:，利用微信号完成一些功能的定制化开发⭐ 微信机器人:smiling_imp:，利用微信号完成一些功能的定制化开发⭐
* 模块简单易用，易于扩展
* 支持定制化开发，如日志记录，自动回复 * 支持定制化开发，如日志记录，自动回复
* 突破网页版登录限制📣 * 突破登录限制📣
* 无需重复扫码登录 * 无需重复扫码登录
* 支持多个微信号同时登陆 * 支持多个微信号同时登陆
@ -115,7 +115,7 @@ func main() {
### 添加微信(EatMoreApple):apple:（备注: openwechat），进群交流:smiling_imp: ### 添加微信(EatMoreApple):apple:（备注: openwechat），进群交流:smiling_imp:
**如果二维码图片没显示出来，请添加微信号 EatMoreApple** **如果二维码图片没显示出来，请添加微信号 eatmoreapple**
<img width="210px" src="https://raw.githubusercontent.com/eatmoreapple/eatMoreApple/main/img/wechat.jpg" align="left"> <img width="210px" src="https://raw.githubusercontent.com/eatmoreapple/eatMoreApple/main/img/wechat.jpg" align="left">

39
source/bot.md
View File

@ -84,6 +84,8 @@ bot.Login()
// 创建热存储容器对象 // 创建热存储容器对象
reloadStorage := openwechat.NewJsonFileHotReloadStorage("storage.json") reloadStorage := openwechat.NewJsonFileHotReloadStorage("storage.json")
defer reloadStorage.Close()
// 执行热登录 // 执行热登录
bot.HotLogin(reloadStorage) bot.HotLogin(reloadStorage)
``` ```
@ -95,7 +97,7 @@ bot.HotLogin(reloadStorage)
我们只需要在`HotLogin`增加一个参数，让它在失败后执行扫码登录即可 我们只需要在`HotLogin`增加一个参数，让它在失败后执行扫码登录即可
```go ```go
bot.HotLogin(reloadStorage, openwechat.HotLoginWithRetry(true)) bot.HotLogin(reloadStorage, openwechat.NewRetryLoginOption())
``` ```
当扫码登录成功后，会将会话信息写入到`热存储容器`中，下次再执行热登录的时候就会从`热存储容器`中读取会话信息，直接登录成功。 当扫码登录成功后，会将会话信息写入到`热存储容器`中，下次再执行热登录的时候就会从`热存储容器`中读取会话信息，直接登录成功。
@ -119,29 +121,23 @@ type HotReloadStorage io.ReadWriter
openwechat也提供了这样的功能。 openwechat也提供了这样的功能。
```go ```go
bot.PushLogin(storage HotReloadStorage, opts ...PushLoginOptionFunc) error bot.PushLogin(storage HotReloadStorage, opts ...openwechat.BotLoginOption) error
``` ```
`PushLogin`需要传入一个`热存储容器`，和一些可选参数。 `PushLogin`需要传入一个`热存储容器`，和一些可选参数。
`HotReloadStorage` 跟上面一样，用来保存会话信息，必要参数。 `HotReloadStorage` 跟上面一样，用来保存会话信息，必要参数。
`PushLoginOptionFunc`是一个可选参数，用来设置一些额外的行为。 `openwechat.BotLoginOption`是一个可选参数，用来设置一些额外的行为。
目前有下面几个可选参数： 目前有下面几个可选参数：
```go ```go
// PushLoginWithoutUUIDCallback 设置 PushLogin 不执行二维码回调, 默认为 true // NewSyncReloadDataLoginOption 登录成功后定时同步热存储容器数据
func PushLoginWithoutUUIDCallback(flag bool) PushLoginOptionFunc func NewSyncReloadDataLoginOption(duration time.Duration) BotLoginOption
// PushLoginWithoutScanCallback 设置 PushLogin 不执行扫码回调， 默认为true // NewRetryLoginOption 登录失败后进行扫码登录
func PushLoginWithoutScanCallback(flag bool) PushLoginOptionFunc func NewRetryLoginOption() BotLoginOption
// PushLoginWithoutLoginCallback 设置 PushLogin 不执行登录回调，默认为false
func PushLoginWithoutLoginCallback(flag bool) PushLoginOptionFunc
// PushLoginWithRetry 设置 PushLogin 失败后执行扫码登录，默认为false
func PushLoginWithRetry(flag bool) PushLoginOptionFunc
``` ```
注意：如果是第一次登录，``PushLogin`` 一定会失败的，因为我们的`HotReloadStorage`里面没有会话信息，你需要设置失败会进行扫码登录。 注意：如果是第一次登录，``PushLogin`` 一定会失败的，因为我们的`HotReloadStorage`里面没有会话信息，你需要设置失败会进行扫码登录。
@ -149,7 +145,8 @@ func PushLoginWithRetry(flag bool) PushLoginOptionFunc
```go ```go
bot := openwechat.DefaultBot() bot := openwechat.DefaultBot()
reloadStorage := openwechat.NewJsonFileHotReloadStorage("storage.json") reloadStorage := openwechat.NewJsonFileHotReloadStorage("storage.json")
err = bot.PushLogin(reloadStorage, openwechat.PushLoginWithRetry(true)) defer reloadStorage.Close()
err = bot.PushLogin(reloadStorage, openwechat.NewRetryLoginOption())
``` ```
这样当第一次登录失败的时候，会自动执行扫码登录。 这样当第一次登录失败的时候，会自动执行扫码登录。
@ -164,13 +161,21 @@ err = bot.PushLogin(reloadStorage, openwechat.PushLoginWithRetry(true))
通过对`bot`对象绑定扫码回调即可实现对应的功能。 通过对`bot`对象绑定扫码回调即可实现对应的功能。
```go ```go
bot.ScanCallBack = func(body []byte) { fmt.Println(string(body)) } bot.ScanCallBack = func(body openwechat.CheckLoginResponse) { fmt.Println(string(body)) }
``` ```
用户扫码后，body里面会携带用户的头像信息。 用户扫码后，body里面会携带用户的头像信息。
**注**：绑定扫码回调须在登录前执行。 **注**：绑定扫码回调须在登录前执行。
`CheckLoginResponse` 是一个`[]byte`包装类型, 扫码成功后可以通过该类型获取用户的头像信息。
```go
type CheckLoginResponse []byte
func (c CheckLoginResponse) Avatar() (string, error)
```
### 登录回调 ### 登录回调
@ -178,13 +183,13 @@ bot.ScanCallBack = func(body []byte) { fmt.Println(string(body)) }
对`bot`对象绑定登录 对`bot`对象绑定登录
```go ```go
bot.LoginCallBack = func(body []byte) { bot.LoginCallBack = func(body openwechat.CheckLoginResponse) {
fmt.Println(string(body)) fmt.Println(string(body))
// to do your business // to do your business
} }
``` ```
登录回调的参数就是当前客户端需要跳转的链接，可以不用关心它。 登录回调的参数就是当前客户端需要跳转的链接，用户可以不用关心它。（其实可以拿来做一些骚操作😈）
登录回调函数可以当做一个信号处理，表示当前扫码登录的用户已经确认登录。 登录回调函数可以当做一个信号处理，表示当前扫码登录的用户已经确认登录。

127
source/message.md
View File

@ -1,7 +1,5 @@
# 消息 # 消息
### 接受消息 ### 接受消息
被动接受的消息对象，由微信服务器发出 被动接受的消息对象，由微信服务器发出
@ -9,29 +7,25 @@
消息对象通过绑定在`bot`上的消息回调函数获取 消息对象通过绑定在`bot`上的消息回调函数获取
```go ```go
bot.MessageHandler = func(msg *openwechat.Message) { bot.MessageHandler = func (msg *openwechat.Message) {
if msg.IsText() && msg.Content == "ping" { if msg.IsText() && msg.Content == "ping" {
msg.ReplyText("pong") msg.ReplyText("pong")
} }
} }
``` ```
以下简写为`msg` 以下简写为`msg`
#### 消息内容 #### 消息内容
```go ```go
msg.Content // 获取消息内容 msg.Content // 获取消息内容
``` ```
通过访问`Content`属性可直接获取消息内容 通过访问`Content`属性可直接获取消息内容
由于消息分为很多种类型，它们都共用`Content`属性。一般当消息类型为文本类型的时候，我们才会去访问`Content`属性。 由于消息分为很多种类型，它们都共用`Content`属性。一般当消息类型为文本类型的时候，我们才会去访问`Content`属性。
#### 消息类型判断 #### 消息类型判断
下面的判断消息类型的方法均返回`bool`值 下面的判断消息类型的方法均返回`bool`值
@ -117,13 +111,17 @@ msg.IsIsPaiYiPai() // 拍一拍消息
msg.IsTickled() msg.IsTickled()
``` ```
##### 判断是否拍了拍自己
```go
msg.IsTickledMe()
```
##### 判断是否有新人加入群聊 ##### 判断是否有新人加入群聊
```go ```go
msg.IsJoinGroup() msg.IsJoinGroup()
``` ```
#### 获取消息的发送者 #### 获取消息的发送者
```go ```go
@ -132,16 +130,12 @@ sender, err := msg.Sender()
如果是群聊消息，该方法返回的是群聊对象(需要自己将`User`转换为`Group`对象) 如果是群聊消息，该方法返回的是群聊对象(需要自己将`User`转换为`Group`对象)
#### 获取消息的接受者 #### 获取消息的接受者
```go ```go
receiver, err := msg.Receiver() receiver, err := msg.Receiver()
``` ```
#### 获取消息在群里面的发送者 #### 获取消息在群里面的发送者
```go ```go
@ -150,8 +144,6 @@ sender, err := msg.SenderInGroup()
获取群聊中具体发消息的用户，前提该消息必须来自群聊。 获取群聊中具体发消息的用户，前提该消息必须来自群聊。
#### 是否由自己发送 #### 是否由自己发送
```go ```go
@ -164,31 +156,24 @@ msg.IsSendBySelf()
msg.IsTickled() msg.IsTickled()
``` ```
#### 消息是否由好友发出 #### 消息是否由好友发出
```go ```go
msg.IsSendByFriend() msg.IsSendByFriend()
``` ```
#### 消息是否由群聊发出 #### 消息是否由群聊发出
```go ```go
msg.IsSendByGroup() msg.IsSendByGroup()
``` ```
#### 回复文本消息 #### 回复文本消息
```go ```go
msg.ReplyText("hello") msg.ReplyText("hello")
``` ```
#### 回复图片消息 #### 回复图片消息
```go ```go
@ -197,8 +182,6 @@ defer img.Close()
msg.ReplyImage(img) msg.ReplyImage(img)
``` ```
#### 回复文件消息 #### 回复文件消息
```go ```go
@ -207,14 +190,12 @@ defer file.Close()
msg.ReplyFile(file) msg.ReplyFile(file)
``` ```
#### 获取消息里的其他信息 #### 获取消息里的其他信息
##### 名片消息 ##### 名片消息
```go ```go
card, err := msg. Card() card, err := msg.Card()
``` ```
该方法调用的前提为`msg.IsCard()`返回为`true` 该方法调用的前提为`msg.IsCard()`返回为`true`
@ -230,31 +211,29 @@ alias := card.Alias
```go ```go
// 名片消息内容 // 名片消息内容
type Card struct { type Card struct {
XMLName xml.Name `xml:"msg"` XMLName xml.Name `xml:"msg"`
ImageStatus int `xml:"imagestatus,attr"` ImageStatus int `xml:"imagestatus,attr"`
Scene int `xml:"scene,attr"` Scene int `xml:"scene,attr"`
Sex int `xml:"sex,attr"` Sex int `xml:"sex,attr"`
Certflag int `xml:"certflag,attr"` Certflag int `xml:"certflag,attr"`
BigHeadImgUrl string `xml:"bigheadimgurl,attr"` BigHeadImgUrl string `xml:"bigheadimgurl,attr"`
SmallHeadImgUrl string `xml:"smallheadimgurl,attr"` SmallHeadImgUrl string `xml:"smallheadimgurl,attr"`
UserName string `xml:"username,attr"` UserName string `xml:"username,attr"`
NickName string `xml:"nickname,attr"` NickName string `xml:"nickname,attr"`
ShortPy string `xml:"shortpy,attr"` ShortPy string `xml:"shortpy,attr"`
Alias string `xml:"alias,attr"` // Note: 这个是名片用户的微信号 Alias string `xml:"alias,attr"` // Note: 这个是名片用户的微信号
Province string `xml:"province,attr"` Province string `xml:"province,attr"`
City string `xml:"city,attr"` City string `xml:"city,attr"`
Sign string `xml:"sign,attr"` Sign string `xml:"sign,attr"`
Certinfo string `xml:"certinfo,attr"` Certinfo string `xml:"certinfo,attr"`
BrandIconUrl string `xml:"brandIconUrl,attr"` BrandIconUrl string `xml:"brandIconUrl,attr"`
BrandHomeUr string `xml:"brandHomeUr,attr"` BrandHomeUr string `xml:"brandHomeUr,attr"`
BrandSubscriptConfigUrl string `xml:"brandSubscriptConfigUrl,attr"` BrandSubscriptConfigUrl string `xml:"brandSubscriptConfigUrl,attr"`
BrandFlags string `xml:"brandFlags,attr"` BrandFlags string `xml:"brandFlags,attr"`
RegionCode string `xml:"regionCode,attr"` RegionCode string `xml:"regionCode,attr"`
} }
``` ```
##### 获取已撤回的消息 ##### 获取已撤回的消息
```go ```go
@ -267,19 +246,17 @@ revokeMsg, err := msg.RevokeMsg()
```go ```go
type RevokeMsg struct { type RevokeMsg struct {
SysMsg xml.Name `xml:"sysmsg"` SysMsg xml.Name `xml:"sysmsg"`
Type string `xml:"type,attr"` Type string `xml:"type,attr"`
RevokeMsg struct { RevokeMsg struct {
OldMsgId int64 `xml:"oldmsgid"` OldMsgId int64 `xml:"oldmsgid"`
MsgId int64 `xml:"msgid"` MsgId int64 `xml:"msgid"`
Session string `xml:"session"` Session string `xml:"session"`
ReplaceMsg string `xml:"replacemsg"` ReplaceMsg string `xml:"replacemsg"`
} `xml:"revokemsg"` } `xml:"revokemsg"`
} }
``` ```
#### 同意好友请求 #### 同意好友请求
```go ```go
@ -291,8 +268,6 @@ friend, err := msg.Agree()
该方法调用成功的前提是`msg.IsFriendAdd()`返回为`true` 该方法调用成功的前提是`msg.IsFriendAdd()`返回为`true`
#### 设置为已读 #### 设置为已读
```go ```go
@ -301,10 +276,6 @@ msg.AsRead()
该当前消息设置为已读 该当前消息设置为已读
#### 设置消息的上下文 #### 设置消息的上下文
用于多个消息处理函数之间的通信，并且是协程安全的。 用于多个消息处理函数之间的通信，并且是协程安全的。
@ -321,10 +292,6 @@ msg.Set("hello", "world")
value, exist := msg.Get("hello") value, exist := msg.Get("hello")
``` ```
### 已发送消息 ### 已发送消息
已发送消息指当前用户发送出去的消息 已发送消息指当前用户发送出去的消息
@ -339,8 +306,6 @@ sentMsg, err := msg.ReplyText("hello") // 通过回复消息获取
// and so on // and so on
``` ```
#### 撤回消息 #### 撤回消息
撤回刚刚发送的消息，撤回消息的有效时间为2分钟，超过了这个时间则无法撤回 撤回刚刚发送的消息，撤回消息的有效时间为2分钟，超过了这个时间则无法撤回
@ -349,16 +314,12 @@ sentMsg, err := msg.ReplyText("hello") // 通过回复消息获取
sentMsg.Revoke() sentMsg.Revoke()
``` ```
#### 判断是否可以撤回 #### 判断是否可以撤回
```go ```go
sentMsg.CanRevoke() sentMsg.CanRevoke()
``` ```
#### 转发给好友 #### 转发给好友
```go ```go
@ -367,8 +328,6 @@ sentMsg.ForwardToFriends(friend1, friend2)
将刚发送的消息转发给好友 将刚发送的消息转发给好友
#### 转发给群聊 #### 转发给群聊
```go ```go
@ -377,10 +336,6 @@ sentMsg.ForwardToGroups(group1, group2)
将刚发送的消息转发给群聊 将刚发送的消息转发给群聊
### Emoji表情 ### Emoji表情
openwechat提供了微信全套`emoji`表情的支持 openwechat提供了微信全套`emoji`表情的支持
@ -392,7 +347,7 @@ emoji表情可以通过发送`Text`类型的函数发送
如 如
```go ```go
firend.SendText(openwechat.Emoji.Doge) // 发送狗头表情 firend.SendText(openwechat.Emoji.Doge) // 发送狗头表情
msg.ReplyText(openwechat.Emoji.Awesome) // 发送666的表情 msg.ReplyText(openwechat.Emoji.Awesome) // 发送666的表情
``` ```