mirror of
https://github.com/silenceper/wechat.git
synced 2026-02-04 21:02:25 +08:00
04b62f6c3c
* fix(work): fixed AddGroupWelcomeTemplate Error fixed AddGroupWelcomeTemplate Error , errcode=40063 , errmsg=some parameters are empty * fix(work): fixed AddGroupWelcomeTemplate Error fixed AddGroupWelcomeTemplate Error , errcode=40063 , errmsg=some parameters are empty
467 lines
16 KiB
Go
467 lines
16 KiB
Go
package externalcontact
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/silenceper/wechat/v2/util"
|
|
)
|
|
|
|
const (
|
|
// addMsgTemplateURL 创建企业群发
|
|
addMsgTemplateURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_msg_template?access_token=%s"
|
|
// getGroupMsgListV2URL 获取群发记录列表
|
|
getGroupMsgListV2URL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_list_v2?access_token=%s"
|
|
// getGroupMsgTaskURL 获取群发成员发送任务列表
|
|
getGroupMsgTaskURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_task?access_token=%s"
|
|
// getGroupMsgSendResultURL 获取企业群发成员执行结果
|
|
getGroupMsgSendResultURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_send_result?access_token=%s"
|
|
// sendWelcomeMsgURL 发送新客户欢迎语
|
|
sendWelcomeMsgURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/send_welcome_msg?access_token=%s"
|
|
// addGroupWelcomeTemplateURL 添加入群欢迎语素材
|
|
addGroupWelcomeTemplateURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/group_welcome_template/add?access_token=%s"
|
|
// editGroupWelcomeTemplateURL 编辑入群欢迎语素材
|
|
editGroupWelcomeTemplateURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/group_welcome_template/edit?access_token=%s"
|
|
// getGroupWelcomeTemplateURL 获取入群欢迎语素材
|
|
getGroupWelcomeTemplateURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/group_welcome_template/get?access_token=%s"
|
|
// delGroupWelcomeTemplateURL 删除入群欢迎语素材
|
|
delGroupWelcomeTemplateURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/group_welcome_template/del?access_token=%s"
|
|
// remindGroupMsgSendURL 提醒成员群发
|
|
remindGroupMsgSendURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remind_groupmsg_send?access_token=%s"
|
|
// cancelGroupMsgSendURL 停止企业群发
|
|
cancelGroupMsgSendURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/cancel_groupmsg_send?access_token=%s"
|
|
)
|
|
|
|
// AddMsgTemplateRequest 创建企业群发请求
|
|
type AddMsgTemplateRequest struct {
|
|
ChatType string `json:"chat_type"`
|
|
ExternalUserID []string `json:"external_userid"`
|
|
Sender string `json:"sender,omitempty"`
|
|
Text MsgText `json:"text"`
|
|
Attachments []*Attachment `json:"attachments"`
|
|
AllowSelect bool `json:"allow_select,omitempty"`
|
|
ChatIDList []string `json:"chat_id_list,omitempty"`
|
|
TagFilter TagFilter `json:"tag_filter,omitempty"`
|
|
}
|
|
|
|
type (
|
|
// TagFilter 标签过滤
|
|
TagFilter struct {
|
|
GroupList []TagGroupList `json:"group_list"`
|
|
}
|
|
|
|
// TagGroupList 标签组
|
|
TagGroupList struct {
|
|
TagList []string `json:"tag_list"`
|
|
}
|
|
)
|
|
|
|
// MsgText 文本消息
|
|
type MsgText struct {
|
|
Content string `json:"content"`
|
|
}
|
|
|
|
type (
|
|
// Attachment 附件
|
|
Attachment struct {
|
|
MsgType string `json:"msgtype"`
|
|
Image AttachmentImg `json:"image,omitempty"`
|
|
Link AttachmentLink `json:"link,omitempty"`
|
|
MiniProgram AttachmentMiniProgram `json:"miniprogram,omitempty"`
|
|
Video AttachmentVideo `json:"video,omitempty"`
|
|
File AttachmentFile `json:"file,omitempty"`
|
|
}
|
|
// AttachmentImg 图片消息
|
|
AttachmentImg struct {
|
|
MediaID string `json:"media_id"`
|
|
PicURL string `json:"pic_url"`
|
|
}
|
|
// AttachmentLink 图文消息
|
|
AttachmentLink struct {
|
|
Title string `json:"title"`
|
|
PicURL string `json:"picurl"`
|
|
Desc string `json:"desc"`
|
|
URL string `json:"url"`
|
|
}
|
|
// AttachmentMiniProgram 小程序消息
|
|
AttachmentMiniProgram struct {
|
|
Title string `json:"title"`
|
|
PicMediaID string `json:"pic_media_id"`
|
|
AppID string `json:"appid"`
|
|
Page string `json:"page"`
|
|
}
|
|
// AttachmentVideo 视频消息
|
|
AttachmentVideo struct {
|
|
MediaID string `json:"media_id"`
|
|
}
|
|
// AttachmentFile 文件消息
|
|
AttachmentFile struct {
|
|
MediaID string `json:"media_id"`
|
|
}
|
|
)
|
|
|
|
// AddMsgTemplateResponse 创建企业群发响应
|
|
type AddMsgTemplateResponse struct {
|
|
util.CommonError
|
|
FailList []string `json:"fail_list"`
|
|
MsgID string `json:"msgid"`
|
|
}
|
|
|
|
// AddMsgTemplate 创建企业群发
|
|
// see https://developer.work.weixin.qq.com/document/path/92135
|
|
func (r *Client) AddMsgTemplate(req *AddMsgTemplateRequest) (*AddMsgTemplateResponse, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(addMsgTemplateURL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &AddMsgTemplateResponse{}
|
|
err = util.DecodeWithError(response, result, "AddMsgTemplate")
|
|
return result, err
|
|
}
|
|
|
|
// GetGroupMsgListV2Request 获取群发记录列表请求
|
|
type GetGroupMsgListV2Request struct {
|
|
ChatType string `json:"chat_type"`
|
|
StartTime int64 `json:"start_time"`
|
|
EndTime int64 `json:"end_time"`
|
|
Creator string `json:"creator,omitempty"`
|
|
FilterType int `json:"filter_type"`
|
|
Limit int `json:"limit"`
|
|
Cursor string `json:"cursor"`
|
|
}
|
|
|
|
// GetGroupMsgListV2Response 获取群发记录列表响应
|
|
type GetGroupMsgListV2Response struct {
|
|
util.CommonError
|
|
NextCursor string `json:"next_cursor"`
|
|
GroupMsgList []*GroupMsg `json:"group_msg_list"`
|
|
}
|
|
|
|
// GroupMsg 群发消息
|
|
type GroupMsg struct {
|
|
MsgID string `json:"msgid"`
|
|
Creator string `json:"creator"`
|
|
CreateTime int64 `json:"create_time"`
|
|
CreateType int `json:"create_type"`
|
|
Text MsgText `json:"text"`
|
|
Attachments []*Attachment `json:"attachments"`
|
|
}
|
|
|
|
// GetGroupMsgListV2 获取群发记录列表
|
|
// see https://developer.work.weixin.qq.com/document/path/93338#%E8%8E%B7%E5%8F%96%E7%BE%A4%E5%8F%91%E8%AE%B0%E5%BD%95%E5%88%97%E8%A1%A8
|
|
func (r *Client) GetGroupMsgListV2(req *GetGroupMsgListV2Request) (*GetGroupMsgListV2Response, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(getGroupMsgListV2URL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &GetGroupMsgListV2Response{}
|
|
err = util.DecodeWithError(response, result, "GetGroupMsgListV2")
|
|
return result, err
|
|
}
|
|
|
|
// GetGroupMsgTaskRequest 获取群发成员发送任务列表请求
|
|
type GetGroupMsgTaskRequest struct {
|
|
MsgID string `json:"msgid"`
|
|
Limit int `json:"limit"`
|
|
Cursor string `json:"cursor"`
|
|
}
|
|
|
|
// GetGroupMsgTaskResponse 获取群发成员发送任务列表响应
|
|
type GetGroupMsgTaskResponse struct {
|
|
util.CommonError
|
|
NextCursor string `json:"next_cursor"`
|
|
TaskList []*Task `json:"task_list"`
|
|
}
|
|
|
|
// Task 获取群发成员发送任务列表任务
|
|
type Task struct {
|
|
UserID string `json:"userid"`
|
|
Status int `json:"status"`
|
|
SendTime int `json:"send_time"`
|
|
}
|
|
|
|
// GetGroupMsgTask 获取群发成员发送任务列表
|
|
// see https://developer.work.weixin.qq.com/document/path/93338#%E8%8E%B7%E5%8F%96%E7%BE%A4%E5%8F%91%E6%88%90%E5%91%98%E5%8F%91%E9%80%81%E4%BB%BB%E5%8A%A1%E5%88%97%E8%A1%A8
|
|
func (r *Client) GetGroupMsgTask(req *GetGroupMsgTaskRequest) (*GetGroupMsgTaskResponse, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(getGroupMsgTaskURL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &GetGroupMsgTaskResponse{}
|
|
err = util.DecodeWithError(response, result, "GetGroupMsgTask")
|
|
return result, err
|
|
}
|
|
|
|
// GetGroupMsgSendResultRequest 获取企业群发成员执行结果请求
|
|
type GetGroupMsgSendResultRequest struct {
|
|
MsgID string `json:"msgid"`
|
|
UserID string `json:"userid"`
|
|
Limit int `json:"limit"`
|
|
Cursor string `json:"cursor"`
|
|
}
|
|
|
|
// GetGroupMsgSendResultResponse 获取企业群发成员执行结果响应
|
|
type GetGroupMsgSendResultResponse struct {
|
|
util.CommonError
|
|
NextCursor string `json:"next_cursor"`
|
|
SendList []*Send `json:"send_list"`
|
|
}
|
|
|
|
// Send 企业群发成员执行结果
|
|
type Send struct {
|
|
ExternalUserID string `json:"external_userid"`
|
|
ChatID string `json:"chat_id"`
|
|
UserID string `json:"userid"`
|
|
Status int `json:"status"`
|
|
SendTime int `json:"send_time"`
|
|
}
|
|
|
|
// GetGroupMsgSendResult 获取企业群发成员执行结果
|
|
// see https://developer.work.weixin.qq.com/document/path/93338#%E8%8E%B7%E5%8F%96%E4%BC%81%E4%B8%9A%E7%BE%A4%E5%8F%91%E6%88%90%E5%91%98%E6%89%A7%E8%A1%8C%E7%BB%93%E6%9E%9C
|
|
func (r *Client) GetGroupMsgSendResult(req *GetGroupMsgSendResultRequest) (*GetGroupMsgSendResultResponse, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(getGroupMsgSendResultURL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &GetGroupMsgSendResultResponse{}
|
|
err = util.DecodeWithError(response, result, "GetGroupMsgSendResult")
|
|
return result, err
|
|
}
|
|
|
|
// SendWelcomeMsgRequest 发送新客户欢迎语请求
|
|
type SendWelcomeMsgRequest struct {
|
|
WelcomeCode string `json:"welcome_code"`
|
|
Text MsgText `json:"text"`
|
|
Attachments []*Attachment `json:"attachments"`
|
|
}
|
|
|
|
// SendWelcomeMsgResponse 发送新客户欢迎语响应
|
|
type SendWelcomeMsgResponse struct {
|
|
util.CommonError
|
|
}
|
|
|
|
// SendWelcomeMsg 发送新客户欢迎语
|
|
// see https://developer.work.weixin.qq.com/document/path/92137
|
|
func (r *Client) SendWelcomeMsg(req *SendWelcomeMsgRequest) error {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(sendWelcomeMsgURL, accessToken), req); err != nil {
|
|
return err
|
|
}
|
|
result := &SendWelcomeMsgResponse{}
|
|
return util.DecodeWithError(response, result, "SendWelcomeMsg")
|
|
}
|
|
|
|
// AddGroupWelcomeTemplateRequest 添加入群欢迎语素材请求
|
|
type AddGroupWelcomeTemplateRequest struct {
|
|
Text MsgText `json:"text"`
|
|
Image *AttachmentImg `json:"image,omitempty"`
|
|
Link *AttachmentLink `json:"link,omitempty"`
|
|
MiniProgram *AttachmentMiniProgram `json:"miniprogram,omitempty"`
|
|
File *AttachmentFile `json:"file,omitempty"`
|
|
Video *AttachmentVideo `json:"video,omitempty"`
|
|
AgentID int `json:"agentid,omitempty"`
|
|
Notify int `json:"notify,omitempty"`
|
|
}
|
|
|
|
// AddGroupWelcomeTemplateResponse 添加入群欢迎语素材响应
|
|
type AddGroupWelcomeTemplateResponse struct {
|
|
util.CommonError
|
|
TemplateID string `json:"template_id"`
|
|
}
|
|
|
|
// AddGroupWelcomeTemplate 添加入群欢迎语素材
|
|
// see https://developer.work.weixin.qq.com/document/path/92366#%E6%B7%BB%E5%8A%A0%E5%85%A5%E7%BE%A4%E6%AC%A2%E8%BF%8E%E8%AF%AD%E7%B4%A0%E6%9D%90
|
|
func (r *Client) AddGroupWelcomeTemplate(req *AddGroupWelcomeTemplateRequest) (*AddGroupWelcomeTemplateResponse, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(addGroupWelcomeTemplateURL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &AddGroupWelcomeTemplateResponse{}
|
|
err = util.DecodeWithError(response, result, "AddGroupWelcomeTemplate")
|
|
return result, err
|
|
}
|
|
|
|
// EditGroupWelcomeTemplateRequest 编辑入群欢迎语素材请求
|
|
type EditGroupWelcomeTemplateRequest struct {
|
|
TemplateID string `json:"template_id"`
|
|
Text MsgText `json:"text"`
|
|
Image *AttachmentImg `json:"image"`
|
|
Link *AttachmentLink `json:"link"`
|
|
MiniProgram *AttachmentMiniProgram `json:"miniprogram"`
|
|
File *AttachmentFile `json:"file"`
|
|
Video *AttachmentVideo `json:"video"`
|
|
AgentID int `json:"agentid"`
|
|
}
|
|
|
|
// EditGroupWelcomeTemplateResponse 编辑入群欢迎语素材响应
|
|
type EditGroupWelcomeTemplateResponse struct {
|
|
util.CommonError
|
|
}
|
|
|
|
// EditGroupWelcomeTemplate 编辑入群欢迎语素材
|
|
// see https://developer.work.weixin.qq.com/document/path/92366#%E7%BC%96%E8%BE%91%E5%85%A5%E7%BE%A4%E6%AC%A2%E8%BF%8E%E8%AF%AD%E7%B4%A0%E6%9D%90
|
|
func (r *Client) EditGroupWelcomeTemplate(req *EditGroupWelcomeTemplateRequest) error {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(editGroupWelcomeTemplateURL, accessToken), req); err != nil {
|
|
return err
|
|
}
|
|
result := &EditGroupWelcomeTemplateResponse{}
|
|
return util.DecodeWithError(response, result, "EditGroupWelcomeTemplate")
|
|
}
|
|
|
|
// GetGroupWelcomeTemplateRequest 获取入群欢迎语素材请求
|
|
type GetGroupWelcomeTemplateRequest struct {
|
|
TemplateID string `json:"template_id"`
|
|
}
|
|
|
|
// GetGroupWelcomeTemplateResponse 获取入群欢迎语素材响应
|
|
type GetGroupWelcomeTemplateResponse struct {
|
|
util.CommonError
|
|
Text MsgText `json:"text"`
|
|
Image AttachmentImg `json:"image,omitempty"`
|
|
Link AttachmentLink `json:"link,omitempty"`
|
|
MiniProgram AttachmentMiniProgram `json:"miniprogram,omitempty"`
|
|
File AttachmentFile `json:"file,omitempty"`
|
|
Video AttachmentVideo `json:"video,omitempty"`
|
|
}
|
|
|
|
// GetGroupWelcomeTemplate 获取入群欢迎语素材
|
|
// see https://developer.work.weixin.qq.com/document/path/92366#%E8%8E%B7%E5%8F%96%E5%85%A5%E7%BE%A4%E6%AC%A2%E8%BF%8E%E8%AF%AD%E7%B4%A0%E6%9D%90
|
|
func (r *Client) GetGroupWelcomeTemplate(req *GetGroupWelcomeTemplateRequest) (*GetGroupWelcomeTemplateResponse, error) {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return nil, err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(getGroupWelcomeTemplateURL, accessToken), req); err != nil {
|
|
return nil, err
|
|
}
|
|
result := &GetGroupWelcomeTemplateResponse{}
|
|
err = util.DecodeWithError(response, result, "GetGroupWelcomeTemplate")
|
|
return result, err
|
|
}
|
|
|
|
// DelGroupWelcomeTemplateRequest 删除入群欢迎语素材请求
|
|
type DelGroupWelcomeTemplateRequest struct {
|
|
TemplateID string `json:"template_id"`
|
|
AgentID int `json:"agentid"`
|
|
}
|
|
|
|
// DelGroupWelcomeTemplateResponse 删除入群欢迎语素材响应
|
|
type DelGroupWelcomeTemplateResponse struct {
|
|
util.CommonError
|
|
}
|
|
|
|
// DelGroupWelcomeTemplate 删除入群欢迎语素材
|
|
// see https://developer.work.weixin.qq.com/document/path/92366#%E5%88%A0%E9%99%A4%E5%85%A5%E7%BE%A4%E6%AC%A2%E8%BF%8E%E8%AF%AD%E7%B4%A0%E6%9D%90
|
|
func (r *Client) DelGroupWelcomeTemplate(req *DelGroupWelcomeTemplateRequest) error {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(delGroupWelcomeTemplateURL, accessToken), req); err != nil {
|
|
return err
|
|
}
|
|
result := &DelGroupWelcomeTemplateResponse{}
|
|
return util.DecodeWithError(response, result, "DelGroupWelcomeTemplate")
|
|
}
|
|
|
|
// RemindGroupMsgSendRequest 提醒成员群发请求
|
|
type RemindGroupMsgSendRequest struct {
|
|
MsgID string `json:"msgid"`
|
|
}
|
|
|
|
// RemindGroupMsgSend 提醒成员群发
|
|
// see https://developer.work.weixin.qq.com/document/path/97610
|
|
func (r *Client) RemindGroupMsgSend(req *RemindGroupMsgSendRequest) error {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(remindGroupMsgSendURL, accessToken), req); err != nil {
|
|
return err
|
|
}
|
|
return util.DecodeWithCommonError(response, "RemindGroupMsgSend")
|
|
}
|
|
|
|
// CancelGroupMsgSendRequest 停止企业群发请求
|
|
type CancelGroupMsgSendRequest struct {
|
|
MsgID string `json:"msgid"`
|
|
}
|
|
|
|
// CancelGroupMsgSend 提醒成员群发
|
|
// see https://developer.work.weixin.qq.com/document/path/97611
|
|
func (r *Client) CancelGroupMsgSend(req *CancelGroupMsgSendRequest) error {
|
|
var (
|
|
accessToken string
|
|
err error
|
|
)
|
|
if accessToken, err = r.GetAccessToken(); err != nil {
|
|
return err
|
|
}
|
|
var response []byte
|
|
if response, err = util.PostJSON(fmt.Sprintf(cancelGroupMsgSendURL, accessToken), req); err != nil {
|
|
return err
|
|
}
|
|
return util.DecodeWithCommonError(response, "CancelGroupMsgSend")
|
|
}
|