1
0
mirror of https://github.com/silenceper/wechat.git synced 2026-02-07 06:02:26 +08:00
This commit is contained in:
houseme
2024-07-19 12:04:04 +08:00
parent ba0a1477eb
commit d8fde54f2d
118 changed files with 974 additions and 867 deletions

View File

@@ -1,4 +1,4 @@
// Package message 消息推送,实现企业微信消息推送相关接口https://developer.work.weixin.qq.com/document/path/90235
// Package message 消息推送实现企业微信消息推送相关接口https://developer.work.weixin.qq.com/document/path/90235
package message
import (

View File

@@ -15,33 +15,33 @@ const (
type (
// SendRequestCommon 发送应用消息请求公共参数
SendRequestCommon struct {
// 指定接收消息的成员成员ID列表多个接收者用|分隔最多支持1000个 特殊情况:指定为"@all",则向该企业应用的全部成员发送
// 指定接收消息的成员,成员 ID 列表(多个接收者用‘|’分隔,最多支持 1000 个)。特殊情况:指定为"@all",则向该企业应用的全部成员发送
ToUser string `json:"touser"`
// 指定接收消息的部门部门ID列表多个接收者用|分隔最多支持100个。 当touser为"@all"时忽略本参数
// 指定接收消息的部门,部门 ID 列表,多个接收者用‘|’分隔,最多支持 100 个。当 touser 为"@all"时忽略本参数
ToParty string `json:"toparty"`
// 指定接收消息的标签标签ID列表多个接收者用|分隔最多支持100个。 当touser为"@all"时忽略本参数
// 指定接收消息的标签,标签 ID 列表,多个接收者用‘|’分隔,最多支持 100 个。当 touser 为"@all"时忽略本参数
ToTag string `json:"totag"`
// 消息类型此时固定为text
MsgType string `json:"msgtype"`
// 企业应用的id整型。企业内部开发可在应用的设置页面查看第三方服务商可通过接口 获取企业授权信息 获取该参数值
// 企业应用的 id整型。企业内部开发可在应用的设置页面查看第三方服务商可通过接口 获取企业授权信息 获取该参数值
AgentID string `json:"agentid"`
// 表示是否是保密消息0表示可对外分享1表示不能分享且内容显示水印默认为0
// 表示是否是保密消息0 表示可对外分享1 表示不能分享且内容显示水印,默认为 0
Safe int `json:"safe"`
// 表示是否开启id转译0表示否1表示是默认0。仅第三方应用需要用到企业自建应用可以忽略。
// 表示是否开启 id 转译0 表示否1 表示是,默认 0。仅第三方应用需要用到企业自建应用可以忽略。
EnableIDTrans int `json:"enable_id_trans"`
// 表示是否开启重复消息检查0表示否1表示是默认0
// 表示是否开启重复消息检查0 表示否1 表示是,默认 0
EnableDuplicateCheck int `json:"enable_duplicate_check"`
// 表示是否重复消息检查的时间间隔默认1800s最大不超过4小时
// 表示是否重复消息检查的时间间隔,默认 1800s最大不超过 4 小时
DuplicateCheckInterval int `json:"duplicate_check_interval"`
}
// SendResponse 发送应用消息响应参数
SendResponse struct {
util.CommonError
InvalidUser string `json:"invaliduser"` // 不合法的userid不区分大小写统一转为小写
InvalidParty string `json:"invalidparty"` // 不合法的partyid
InvalidTag string `json:"invalidtag"` // 不合法的标签id
UnlicensedUser string `json:"unlicenseduser"` // 没有基础接口许可(包含已过期)userid
MsgID string `json:"msgid"` // 消息id
InvalidUser string `json:"invaliduser"` // 不合法的 userid不区分大小写统一转为小写
InvalidParty string `json:"invalidparty"` // 不合法的 partyid
InvalidTag string `json:"invalidtag"` // 不合法的标签 id
UnlicensedUser string `json:"unlicenseduser"` // 没有基础接口许可 (包含已过期)userid
MsgID string `json:"msgid"` // 消息 id
ResponseCode string `json:"response_code"`
}
@@ -52,7 +52,7 @@ type (
}
// TextField 文本消息参数
TextField struct {
// 消息内容最长不超过2048个字节超过将截断支持id转译
// 消息内容,最长不超过 2048 个字节,超过将截断(支持 id 转译)
Content string `json:"content"`
}
@@ -63,7 +63,7 @@ type (
}
// ImageField 图片消息参数
ImageField struct {
// 图片媒体文件id可以调用上传临时素材接口获取
// 图片媒体文件 id可以调用上传临时素材接口获取
MediaID string `json:"media_id"`
}
@@ -74,7 +74,7 @@ type (
}
// VoiceField 语音消息参数
VoiceField struct {
// 语音文件id可以调用上传临时素材接口获取
// 语音文件 id可以调用上传临时素材接口获取
MediaID string `json:"media_id"`
}
)
@@ -82,7 +82,7 @@ type (
// Send 发送应用消息
// @desc 实现企业微信发送应用消息接口https://developer.work.weixin.qq.com/document/path/90236
func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error) {
// 获取accessToken
// 获取 accessToken
accessToken, err := r.GetAccessToken()
if err != nil {
return nil, err
@@ -92,7 +92,7 @@ func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error
if err != nil {
return nil, err
}
// 发起http请求
// 发起 http 请求
response, err := util.HTTPPost(fmt.Sprintf(sendURL, accessToken), string(jsonData))
if err != nil {
return nil, err
@@ -106,25 +106,25 @@ func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error
// SendText 发送文本消息
func (r *Client) SendText(request SendTextRequest) (*SendResponse, error) {
// 发送文本消息MsgType参数固定为text
// 发送文本消息 MsgType 参数固定为text
request.MsgType = "text"
return r.Send("MessageSendText", request)
}
// SendImage 发送图片消息
func (r *Client) SendImage(request SendImageRequest) (*SendResponse, error) {
// 发送图片消息MsgType参数固定为image
// 发送图片消息 MsgType 参数固定为image
request.MsgType = "image"
return r.Send("MessageSendImage", request)
}
// SendVoice 发送语音消息
func (r *Client) SendVoice(request SendVoiceRequest) (*SendResponse, error) {
// 发送语音消息MsgType参数固定为voice
// 发送语音消息 MsgType 参数固定为voice
request.MsgType = "voice"
return r.Send("MessageSendVoice", request)
}
// 以上实现了部分常用消息推送SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息,
// 如需扩展其他消息类型,建议按照以上格式,扩展对应消息类型的参数即可
// 也可以直接使用Send方法按照企业微信消息推送的接口文档传对应消息类型的参数来使用
// 也可以直接使用 Send 方法,按照企业微信消息推送的接口文档传对应消息类型的参数来使用