Documentation
¶
Index ¶
- type AddContactWayRequest
- type AddContactWayResponse
- type AddCropTagItem
- type AddCropTagRequest
- type AddCropTagResponse
- type AddGroupWelcomeTemplateRequest
- type AddGroupWelcomeTemplateResponse
- type AddJoinWayRequest
- type AddJoinWayResponse
- type AddMsgTemplateRequest
- type AddMsgTemplateResponse
- type Attachment
- type AttachmentFile
- type AttachmentImg
- type AttachmentLink
- type AttachmentMiniProgram
- type AttachmentVideo
- type BatchGetExternalUserDetailsRequest
- type BehaviorData
- type Client
- func (r *Client) AddContactWay(req *AddContactWayRequest) (*AddContactWayResponse, error)
- func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error)
- func (r *Client) AddGroupWelcomeTemplate(req *AddGroupWelcomeTemplateRequest) (*AddGroupWelcomeTemplateResponse, error)
- func (r *Client) AddJoinWay(req *AddJoinWayRequest) (*AddJoinWayResponse, error)
- func (r *Client) AddMsgTemplate(req *AddMsgTemplateRequest) (*AddMsgTemplateResponse, error)
- func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUserForBatch, error)
- func (r *Client) DelContactWay(req *DelContactWayRequest) (*DelContactWayResponse, error)
- func (r *Client) DelGroupWelcomeTemplate(req *DelGroupWelcomeTemplateRequest) error
- func (r *Client) DelJoinWay(req *JoinWayConfigRequest) error
- func (r *Client) DeleteCropTag(req DeleteCropTagRequest) error
- func (r *Client) EditCropTag(req EditCropTagRequest) error
- func (r *Client) EditGroupWelcomeTemplate(req *EditGroupWelcomeTemplateRequest) error
- func (r *Client) GetCallbackMessage(encryptedMsg []byte) (msg EventCallbackMessage, err error)
- func (r *Client) GetContactWay(req *GetContactWayRequest) (*GetContactWayResponse, error)
- func (r *Client) GetCropTagList(req GetCropTagRequest) ([]TagGroup, error)
- func (r *Client) GetExternalUserDetail(externalUserID string, nextCursor ...string) (*ExternalUserDetailResponse, error)
- func (r *Client) GetExternalUserList(userID string) ([]string, error)
- func (r *Client) GetFollowUserList() ([]string, error)
- func (r *Client) GetGroupChatDetail(req *GroupChatDetailRequest) (*GroupChatDetailResponse, error)
- func (r *Client) GetGroupChatList(req *GroupChatListRequest) (*GroupChatListResponse, error)
- func (r *Client) GetGroupChatStat(req *GetGroupChatStatRequest) (*GetGroupChatStatResponse, error)
- func (r *Client) GetGroupChatStatByDay(req *GetGroupChatStatByDayRequest) ([]GetGroupChatStatByDayItem, error)
- func (r *Client) GetGroupMsgListV2(req *GetGroupMsgListV2Request) (*GetGroupMsgListV2Response, error)
- func (r *Client) GetGroupMsgSendResult(req *GetGroupMsgSendResultRequest) (*GetGroupMsgSendResultResponse, error)
- func (r *Client) GetGroupMsgTask(req *GetGroupMsgTaskRequest) (*GetGroupMsgTaskResponse, error)
- func (r *Client) GetGroupWelcomeTemplate(req *GetGroupWelcomeTemplateRequest) (*GetGroupWelcomeTemplateResponse, error)
- func (r *Client) GetJoinWay(req *JoinWayConfigRequest) (*GetJoinWayResponse, error)
- func (r *Client) GetUserBehaviorData(req *GetUserBehaviorRequest) ([]BehaviorData, error)
- func (r *Client) ListContactWay(req *ListContactWayRequest) (*ListContactWayResponse, error)
- func (r *Client) MarkTag(request MarkTagRequest) error
- func (r *Client) OpengIDToChatID(req *OpengIDToChatIDRequest) (*OpengIDToChatIDResponse, error)
- func (r *Client) SendWelcomeMsg(req *SendWelcomeMsgRequest) error
- func (r *Client) UpdateContactWay(req *UpdateContactWayRequest) (*UpdateContactWayResponse, error)
- func (r *Client) UpdateJoinWay(req *UpdateJoinWayRequest) error
- func (r *Client) UpdateUserRemark(request UpdateUserRemarkRequest) error
- type ConclusionsImageRequest
- type ConclusionsImageResponse
- type ConclusionsLink
- type ConclusionsMiniProgram
- type ConclusionsRequest
- type ConclusionsResponse
- type ConclusionsText
- type ContactWay
- type ContactWayForList
- type DelContactWayRequest
- type DelContactWayResponse
- type DelGroupWelcomeTemplateRequest
- type DelGroupWelcomeTemplateResponse
- type DeleteCropTagRequest
- type EditCropTagRequest
- type EditGroupWelcomeTemplateRequest
- type EditGroupWelcomeTemplateResponse
- type EventCallbackMessage
- type ExternalContact
- type ExternalUser
- type ExternalUserDetailListResponse
- type ExternalUserDetailResponse
- type ExternalUserForBatch
- type ExternalUserListResponse
- type FollowInfo
- type FollowUser
- type GetContactWayRequest
- type GetContactWayResponse
- type GetCropTagListResponse
- type GetCropTagRequest
- type GetGroupChatStatByDayItem
- type GetGroupChatStatByDayRequest
- type GetGroupChatStatByDayResponse
- type GetGroupChatStatRequest
- type GetGroupChatStatResponse
- type GetGroupMsgListV2Request
- type GetGroupMsgListV2Response
- type GetGroupMsgSendResultRequest
- type GetGroupMsgSendResultResponse
- type GetGroupMsgTaskRequest
- type GetGroupMsgTaskResponse
- type GetGroupWelcomeTemplateRequest
- type GetGroupWelcomeTemplateResponse
- type GetJoinWayResponse
- type GetUserBehaviorRequest
- type GetUserBehaviorResponse
- type GroupChat
- type GroupChatAdmin
- type GroupChatDetailRequest
- type GroupChatDetailResponse
- type GroupChatList
- type GroupChatListRequest
- type GroupChatListResponse
- type GroupChatMember
- type GroupChatStatItem
- type GroupChatStatItemData
- type GroupMsg
- type Invitor
- type JoinWay
- type JoinWayConfigRequest
- type ListContactWayRequest
- type ListContactWayResponse
- type MarkTagRequest
- type MsgText
- type OpengIDToChatIDRequest
- type OpengIDToChatIDResponse
- type OwnerFilter
- type Send
- type SendWelcomeMsgRequest
- type SendWelcomeMsgResponse
- type Tag
- type TagGroup
- type TagGroupTagItem
- type Task
- type UpdateContactWayRequest
- type UpdateContactWayResponse
- type UpdateJoinWayRequest
- type UpdateUserRemarkRequest
- type WechatChannel
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddContactWayRequest ¶
type AddContactWayRequest struct {
Type int `json:"type"`
Scene int `json:"scene"`
Style int `json:"style"`
Remark string `json:"remark"`
SkipVerify bool `json:"skip_verify"`
State string `json:"state"`
User []string `json:"user"`
Party []int `json:"party"`
IsTemp bool `json:"is_temp"`
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
Conclusions ConclusionsRequest `json:"conclusions"`
}
AddContactWayRequest 配置客户联系「联系我」方式请求
type AddContactWayResponse ¶
type AddContactWayResponse struct {
util.CommonError
ConfigID string `json:"config_id"`
QrCode string `json:"qr_code"`
}
AddContactWayResponse 配置客户联系「联系我」方式响应
type AddCropTagItem ¶
AddCropTagItem 添加企业标签子项
type AddCropTagRequest ¶
type AddCropTagRequest struct {
GroupID string `json:"group_id,omitempty"`
GroupName string `json:"group_name"`
Order int `json:"order"`
Tag []AddCropTagItem `json:"tag"`
AgentID int `json:"agentid"`
}
AddCropTagRequest 添加企业标签请求
type AddCropTagResponse ¶
type AddCropTagResponse struct {
util.CommonError
TagGroup TagGroup `json:"tag_group"`
}
AddCropTagResponse 添加企业标签响应
type AddGroupWelcomeTemplateRequest ¶
type AddGroupWelcomeTemplateRequest struct {
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"`
Notify int `json:"notify"`
}
AddGroupWelcomeTemplateRequest 添加入群欢迎语素材请求
type AddGroupWelcomeTemplateResponse ¶
type AddGroupWelcomeTemplateResponse struct {
util.CommonError
TemplateID string `json:"template_id"`
}
AddGroupWelcomeTemplateResponse 添加入群欢迎语素材响应
type AddJoinWayRequest ¶
type AddJoinWayRequest struct {
Scene int `json:"scene"` // 必填 1 - 群的小程序插件,2 - 群的二维码插件
Remark string `json:"remark"` //非必填 联系方式的备注信息,用于助记,超过30个字符将被截断
AutoCreateRoom int `json:"auto_create_room"` //非必填 当群满了后,是否自动新建群。0-否;1-是。 默认为1
RoomBaseName string `json:"room_base_name"` //非必填 自动建群的群名前缀,当auto_create_room为1时有效。最长40个utf8字符
RoomBaseID int `json:"room_base_id"` //非必填 自动建群的群起始序号,当auto_create_room为1时有效
ChatIDList []string `json:"chat_id_list"` //必填 使用该配置的客户群ID列表,支持5个。见客户群ID获取方法
State string `json:"state"` //非必填 企业自定义的state参数,用于区分不同的入群渠道。不超过30个UTF-8字符
}
AddJoinWayRequest 添加群配置请求参数
type AddJoinWayResponse ¶
type AddJoinWayResponse struct {
util.CommonError
ConfigID string `json:"config_id"`
}
AddJoinWayResponse 添加群配置返回值
type 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"`
}
AddMsgTemplateRequest 创建企业群发请求
type AddMsgTemplateResponse ¶
type AddMsgTemplateResponse struct {
util.CommonError
FailList []string `json:"fail_list"`
MsgID string `json:"msgid"`
}
AddMsgTemplateResponse 创建企业群发响应
type Attachment ¶
type 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"`
}
Attachment 附件
type AttachmentFile ¶
type AttachmentFile struct {
MediaID string `json:"media_id"`
}
AttachmentFile 文件消息
type AttachmentImg ¶
AttachmentImg 图片消息
type AttachmentLink ¶
type AttachmentLink struct {
Title string `json:"title"`
PicURL string `json:"picurl"`
Desc string `json:"desc"`
URL string `json:"url"`
}
AttachmentLink 图文消息
type AttachmentMiniProgram ¶
type AttachmentMiniProgram struct {
Title string `json:"title"`
PicMediaID string `json:"pic_media_id"`
AppID string `json:"appid"`
Page string `json:"page"`
}
AttachmentMiniProgram 小程序消息
type AttachmentVideo ¶
type AttachmentVideo struct {
MediaID string `json:"media_id"`
}
AttachmentVideo 视频消息
type BatchGetExternalUserDetailsRequest ¶
type BatchGetExternalUserDetailsRequest struct {
UserIDList []string `json:"userid_list"`
Cursor string `json:"cursor"`
Limit int `json:"limit,omitempty"`
}
BatchGetExternalUserDetailsRequest 批量获取外部联系人详情请求
type BehaviorData ¶
type BehaviorData struct {
StatTime int `json:"stat_time"`
ChatCnt int `json:"chat_cnt"`
MessageCnt int `json:"message_cnt"`
ReplyPercentage float64 `json:"reply_percentage"`
AvgReplyTime int `json:"avg_reply_time"`
NegativeFeedbackCnt int `json:"negative_feedback_cnt"`
NewApplyCnt int `json:"new_apply_cnt"`
NewContactCnt int `json:"new_contact_cnt"`
}
BehaviorData 联系客户统计数据
type Client ¶
Client 外部联系接口实例
func (*Client) AddContactWay ¶
func (r *Client) AddContactWay(req *AddContactWayRequest) (*AddContactWayResponse, error)
AddContactWay 配置客户联系「联系我」方式 see https://developer.work.weixin.qq.com/document/path/92228
func (*Client) AddCropTag ¶
func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error)
AddCropTag 添加企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117
func (*Client) AddGroupWelcomeTemplate ¶
func (r *Client) AddGroupWelcomeTemplate(req *AddGroupWelcomeTemplateRequest) (*AddGroupWelcomeTemplateResponse, error)
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 (*Client) AddJoinWay ¶
func (r *Client) AddJoinWay(req *AddJoinWayRequest) (*AddJoinWayResponse, error)
AddJoinWay 加入群聊 @see https://developer.work.weixin.qq.com/document/path/92229
func (*Client) AddMsgTemplate ¶
func (r *Client) AddMsgTemplate(req *AddMsgTemplateRequest) (*AddMsgTemplateResponse, error)
AddMsgTemplate 创建企业群发 see https://developer.work.weixin.qq.com/document/path/92135
func (*Client) BatchGetExternalUserDetails ¶
func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUserForBatch, error)
BatchGetExternalUserDetails 批量获取外部联系人详情 @see https://developer.work.weixin.qq.com/document/path/92994
func (*Client) DelContactWay ¶
func (r *Client) DelContactWay(req *DelContactWayRequest) (*DelContactWayResponse, error)
DelContactWay 删除企业已配置的「联系我」方式 see https://developer.work.weixin.qq.com/document/path/92228
func (*Client) DelGroupWelcomeTemplate ¶
func (r *Client) DelGroupWelcomeTemplate(req *DelGroupWelcomeTemplateRequest) error
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 (*Client) DelJoinWay ¶
func (r *Client) DelJoinWay(req *JoinWayConfigRequest) error
DelJoinWay 删除客户群进群方式配置 @see https://developer.work.weixin.qq.com/document/path/92229
func (*Client) DeleteCropTag ¶
func (r *Client) DeleteCropTag(req DeleteCropTagRequest) error
DeleteCropTag 删除企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117
func (*Client) EditCropTag ¶
func (r *Client) EditCropTag(req EditCropTagRequest) error
EditCropTag 修改企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117
func (*Client) EditGroupWelcomeTemplate ¶
func (r *Client) EditGroupWelcomeTemplate(req *EditGroupWelcomeTemplateRequest) error
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 (*Client) GetCallbackMessage ¶
func (r *Client) GetCallbackMessage(encryptedMsg []byte) (msg EventCallbackMessage, err error)
GetCallbackMessage 获取联系客户回调事件中的消息内容
func (*Client) GetContactWay ¶
func (r *Client) GetContactWay(req *GetContactWayRequest) (*GetContactWayResponse, error)
GetContactWay 获取企业已配置的「联系我」方式 see https://developer.work.weixin.qq.com/document/path/92228
func (*Client) GetCropTagList ¶
func (r *Client) GetCropTagList(req GetCropTagRequest) ([]TagGroup, error)
GetCropTagList 获取企业标签库 @see https://developer.work.weixin.qq.com/document/path/92117
func (*Client) GetExternalUserDetail ¶
func (r *Client) GetExternalUserDetail(externalUserID string, nextCursor ...string) (*ExternalUserDetailResponse, error)
GetExternalUserDetail 获取外部联系人详情 @see https://developer.work.weixin.qq.com/document/path/92114
func (*Client) GetExternalUserList ¶
GetExternalUserList 获取客户列表 @see https://developer.work.weixin.qq.com/document/path/92113
func (*Client) GetFollowUserList ¶
GetFollowUserList 获取配置了客户联系功能的成员列表 @see https://developer.work.weixin.qq.com/document/path/92571
func (*Client) GetGroupChatDetail ¶
func (r *Client) GetGroupChatDetail(req *GroupChatDetailRequest) (*GroupChatDetailResponse, error)
GetGroupChatDetail 获取客户群详情 @see https://developer.work.weixin.qq.com/document/path/92122
func (*Client) GetGroupChatList ¶
func (r *Client) GetGroupChatList(req *GroupChatListRequest) (*GroupChatListResponse, error)
GetGroupChatList 获取客户群列表 @see https://developer.work.weixin.qq.com/document/path/92120
func (*Client) GetGroupChatStat ¶
func (r *Client) GetGroupChatStat(req *GetGroupChatStatRequest) (*GetGroupChatStatResponse, error)
GetGroupChatStat 获取「群聊数据统计」数据 按群主聚合的方式 @see https://developer.work.weixin.qq.com/document/path/92133
func (*Client) GetGroupChatStatByDay ¶
func (r *Client) GetGroupChatStatByDay(req *GetGroupChatStatByDayRequest) ([]GetGroupChatStatByDayItem, error)
GetGroupChatStatByDay 获取「群聊数据统计」数据 按自然日聚合的方式 @see https://developer.work.weixin.qq.com/document/path/92133
func (*Client) GetGroupMsgListV2 ¶
func (r *Client) GetGroupMsgListV2(req *GetGroupMsgListV2Request) (*GetGroupMsgListV2Response, error)
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 (*Client) GetGroupMsgSendResult ¶
func (r *Client) GetGroupMsgSendResult(req *GetGroupMsgSendResultRequest) (*GetGroupMsgSendResultResponse, error)
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 (*Client) GetGroupMsgTask ¶
func (r *Client) GetGroupMsgTask(req *GetGroupMsgTaskRequest) (*GetGroupMsgTaskResponse, error)
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 (*Client) GetGroupWelcomeTemplate ¶
func (r *Client) GetGroupWelcomeTemplate(req *GetGroupWelcomeTemplateRequest) (*GetGroupWelcomeTemplateResponse, error)
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 (*Client) GetJoinWay ¶
func (r *Client) GetJoinWay(req *JoinWayConfigRequest) (*GetJoinWayResponse, error)
GetJoinWay 获取客户群进群方式配置 @see https://developer.work.weixin.qq.com/document/path/92229
func (*Client) GetUserBehaviorData ¶
func (r *Client) GetUserBehaviorData(req *GetUserBehaviorRequest) ([]BehaviorData, error)
GetUserBehaviorData 获取「联系客户统计」数据 @see https://developer.work.weixin.qq.com/document/path/92132
func (*Client) ListContactWay ¶
func (r *Client) ListContactWay(req *ListContactWayRequest) (*ListContactWayResponse, error)
ListContactWay 获取企业已配置的「联系我」列表 see https://developer.work.weixin.qq.com/document/path/92228
func (*Client) MarkTag ¶
func (r *Client) MarkTag(request MarkTagRequest) error
MarkTag 为客户打上标签 @see https://developer.work.weixin.qq.com/document/path/92118
func (*Client) OpengIDToChatID ¶
func (r *Client) OpengIDToChatID(req *OpengIDToChatIDRequest) (*OpengIDToChatIDResponse, error)
OpengIDToChatID 客户群opengid转换 @see https://developer.work.weixin.qq.com/document/path/94828
func (*Client) SendWelcomeMsg ¶
func (r *Client) SendWelcomeMsg(req *SendWelcomeMsgRequest) error
SendWelcomeMsg 发送新客户欢迎语 see https://developer.work.weixin.qq.com/document/path/92137
func (*Client) UpdateContactWay ¶
func (r *Client) UpdateContactWay(req *UpdateContactWayRequest) (*UpdateContactWayResponse, error)
UpdateContactWay 更新企业已配置的「联系我」方式 see https://developer.work.weixin.qq.com/document/path/92228
func (*Client) UpdateJoinWay ¶
func (r *Client) UpdateJoinWay(req *UpdateJoinWayRequest) error
UpdateJoinWay 更新客户群进群方式配置 @see https://developer.work.weixin.qq.com/document/path/92229
func (*Client) UpdateUserRemark ¶
func (r *Client) UpdateUserRemark(request UpdateUserRemarkRequest) error
UpdateUserRemark 修改客户备注信息 @see https://developer.work.weixin.qq.com/document/path/92115
type ConclusionsImageRequest ¶
type ConclusionsImageRequest struct {
MediaID string `json:"media_id"`
}
ConclusionsImageRequest 图片格式结束语请求
type ConclusionsImageResponse ¶
type ConclusionsImageResponse struct {
PicURL string `json:"pic_url"`
}
ConclusionsImageResponse 图片格式结束语响应
type ConclusionsLink ¶
type ConclusionsLink struct {
Title string `json:"title"`
PicURL string `json:"picurl"`
Desc string `json:"desc"`
URL string `json:"url"`
}
ConclusionsLink 链接格式结束语
type ConclusionsMiniProgram ¶
type ConclusionsMiniProgram struct {
Title string `json:"title"`
PicMediaID string `json:"pic_media_id"`
AppID string `json:"appid"`
Page string `json:"page"`
}
ConclusionsMiniProgram 小程序格式结束语
type ConclusionsRequest ¶
type ConclusionsRequest struct {
Text ConclusionsText `json:"text"`
Image ConclusionsImageRequest `json:"image"`
Link ConclusionsLink `json:"link"`
MiniProgram ConclusionsMiniProgram `json:"miniprogram"`
}
ConclusionsRequest 结束语请求
type ConclusionsResponse ¶
type ConclusionsResponse struct {
Text ConclusionsText `json:"text"`
Image ConclusionsImageResponse `json:"image"`
Link ConclusionsLink `json:"link"`
MiniProgram ConclusionsMiniProgram `json:"miniprogram"`
}
ConclusionsResponse 结束语响应
type ConclusionsText ¶
type ConclusionsText struct {
Content string `json:"content"`
}
ConclusionsText 文本格式结束语
type ContactWay ¶
type ContactWay struct {
ConfigID string `json:"config_id"`
Type int `json:"type"`
Scene int `json:"scene"`
Style int `json:"style"`
Remark string `json:"remark"`
SkipVerify bool `json:"skip_verify"`
State string `json:"state"`
QrCode string `json:"qr_code"`
User []string `json:"user"`
Party []int `json:"party"`
IsTemp bool `json:"is_temp"`
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
Conclusions ConclusionsResponse `json:"conclusions"`
}
ContactWay 「联系我」配置
type ContactWayForList ¶
type ContactWayForList struct {
ConfigID string `json:"config_id"`
}
ContactWayForList 「联系我」配置
type DelContactWayRequest ¶
type DelContactWayRequest struct {
ConfigID string `json:"config_id"`
}
DelContactWayRequest 删除企业已配置的「联系我」方式请求
type DelContactWayResponse ¶
type DelContactWayResponse struct {
util.CommonError
}
DelContactWayResponse 删除企业已配置的「联系我」方式响应
type DelGroupWelcomeTemplateRequest ¶
type DelGroupWelcomeTemplateRequest struct {
TemplateID string `json:"template_id"`
AgentID int `json:"agentid"`
}
DelGroupWelcomeTemplateRequest 删除入群欢迎语素材请求
type DelGroupWelcomeTemplateResponse ¶
type DelGroupWelcomeTemplateResponse struct {
util.CommonError
}
DelGroupWelcomeTemplateResponse 删除入群欢迎语素材响应
type DeleteCropTagRequest ¶
type DeleteCropTagRequest struct {
TagID []string `json:"tag_id"`
GroupID []string `json:"group_id"`
AgentID string `json:"agent_id"`
}
DeleteCropTagRequest 删除企业标签请求
type EditCropTagRequest ¶
type EditCropTagRequest struct {
ID string `json:"id"`
Name string `json:"name"`
Order int `json:"order"`
AgentID string `json:"agent_id"`
}
EditCropTagRequest 编辑客户企业标签请求
type 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"`
}
EditGroupWelcomeTemplateRequest 编辑入群欢迎语素材请求
type EditGroupWelcomeTemplateResponse ¶
type EditGroupWelcomeTemplateResponse struct {
util.CommonError
}
EditGroupWelcomeTemplateResponse 编辑入群欢迎语素材响应
type EventCallbackMessage ¶
type EventCallbackMessage struct {
ToUserName string `json:"to_user_name"`
FromUserName string `json:"from_user_name"`
CreateTime int64 `json:"create_time"`
MsgType string `json:"msg_type"`
Event string `json:"event"`
ChangeType string `json:"change_type"`
UserID string `json:"user_id"`
ExternalUserID string `json:"external_user_id"`
State string `json:"state"`
WelcomeCode string `json:"welcome_code"`
}
EventCallbackMessage 微信客户联系回调消息 https://developer.work.weixin.qq.com/document/path/92130
type ExternalContact ¶
type ExternalContact struct {
ExternalUserID string `json:"external_userid"`
Name string `json:"name"`
Position string `json:"position"`
Avatar string `json:"avatar"`
CorpName string `json:"corp_name"`
CorpFullName string `json:"corp_full_name"`
Type int64 `json:"type"`
Gender int64 `json:"gender"`
UnionID string `json:"unionid"`
ExternalProfile string `json:"external_profile"`
}
ExternalContact 批量获取外部联系人用户信息
type ExternalUser ¶
type ExternalUser struct {
ExternalUserID string `json:"external_userid"`
Name string `json:"name"`
Avatar string `json:"avatar"`
Type int64 `json:"type"`
Gender int64 `json:"gender"`
UnionID string `json:"unionid"`
Position string `json:"position"`
CorpName string `json:"corp_name"`
CorpFullName string `json:"corp_full_name"`
ExternalProfile string `json:"external_profile"`
}
ExternalUser 外部联系人
type ExternalUserDetailListResponse ¶
type ExternalUserDetailListResponse struct {
util.CommonError
ExternalContactList []ExternalUserForBatch `json:"external_contact_list"`
}
ExternalUserDetailListResponse 批量获取外部联系人详情响应
type ExternalUserDetailResponse ¶
type ExternalUserDetailResponse struct {
util.CommonError
ExternalContact ExternalUser `json:"external_contact"`
FollowUser []FollowUser `json:"follow_user"`
NextCursor string `json:"next_cursor"`
}
ExternalUserDetailResponse 外部联系人详情响应
type ExternalUserForBatch ¶
type ExternalUserForBatch struct {
ExternalContact ExternalContact `json:"external_contact"`
FollowInfo FollowInfo `json:"follow_info"`
}
ExternalUserForBatch 批量获取外部联系人客户列表
type ExternalUserListResponse ¶
type ExternalUserListResponse struct {
util.CommonError
ExternalUserID []string `json:"external_userid"`
}
ExternalUserListResponse 外部联系人列表响应
type FollowInfo ¶
type FollowInfo struct {
UserID string `json:"userid"`
Remark string `json:"remark"`
Description string `json:"description"`
CreateTime int `json:"create_time"`
TagID []string `json:"tag_id"`
RemarkCorpName string `json:"remark_corp_name"`
RemarkMobiles []string `json:"remark_mobiles"`
OperUserID string `json:"oper_userid"`
AddWay int64 `json:"add_way"`
WeChatChannels WechatChannel `json:"wechat_channels"`
}
FollowInfo 批量获取外部联系人跟进人信息
type FollowUser ¶
type FollowUser struct {
UserID string `json:"userid"`
Remark string `json:"remark"`
Description string `json:"description"`
CreateTime string `json:"create_time"`
Tags []Tag `json:"tags"`
RemarkCorpName string `json:"remark_corp_name"`
RemarkMobiles []string `json:"remark_mobiles"`
OperUserID string `json:"oper_userid"`
AddWay int64 `json:"add_way"`
WeChatChannels WechatChannel `json:"wechat_channels"`
State string `json:"state"`
}
FollowUser 跟进用户(指企业内部用户)
type GetContactWayRequest ¶
type GetContactWayRequest struct {
ConfigID string `json:"config_id"`
}
GetContactWayRequest 获取企业已配置的「联系我」方式请求
type GetContactWayResponse ¶
type GetContactWayResponse struct {
util.CommonError
ContactWay ContactWay `json:"contact_way"`
}
GetContactWayResponse 获取企业已配置的「联系我」方式响应
type GetCropTagListResponse ¶
type GetCropTagListResponse struct {
util.CommonError
TagGroup []TagGroup `json:"tag_group"`
}
GetCropTagListResponse 获取企业标签列表响应
type GetCropTagRequest ¶
GetCropTagRequest 获取企业标签请求
type GetGroupChatStatByDayItem ¶
type GetGroupChatStatByDayItem struct {
StatTime int `json:"stat_time"`
Data GroupChatStatItemData `json:"data"`
}
GetGroupChatStatByDayItem 群聊数据统计(按自然日聚合)条目
type GetGroupChatStatByDayRequest ¶
type GetGroupChatStatByDayRequest struct {
DayBeginTime int `json:"day_begin_time"`
DayEndTime int `json:"day_end_time"`
OwnerFilter OwnerFilter `json:"owner_filter"`
}
GetGroupChatStatByDayRequest 获取「群聊数据统计」数据 按自然日聚合的方式 请求
type GetGroupChatStatByDayResponse ¶
type GetGroupChatStatByDayResponse struct {
util.CommonError
Items []GetGroupChatStatByDayItem `json:"items"`
}
GetGroupChatStatByDayResponse 获取「群聊数据统计」数据 按自然日聚合的方式 响应
type GetGroupChatStatRequest ¶
type GetGroupChatStatRequest struct {
DayBeginTime int `json:"day_begin_time"`
DayEndTime int `json:"day_end_time"`
OwnerFilter OwnerFilter `json:"owner_filter"`
OrderBy int `json:"order_by"`
OrderAsc int `json:"order_asc"`
Offset int `json:"offset"`
Limit int `json:"limit"`
}
GetGroupChatStatRequest 获取「群聊数据统计」数据 按群主聚合的方式 请求
type GetGroupChatStatResponse ¶
type GetGroupChatStatResponse struct {
util.CommonError
Total int `json:"total"`
NextOffset int `json:"next_offset"`
Items []GroupChatStatItem `json:"items"`
}
GetGroupChatStatResponse 获取「群聊数据统计」数据 按群主聚合的方式 响应
type GetGroupMsgListV2Request ¶
type GetGroupMsgListV2Request struct {
ChatType string `json:"chat_type"`
StartTime int `json:"start_time"`
EndTime int `json:"end_time"`
Creator string `json:"creator,omitempty"`
FilterType int `json:"filter_type"`
Limit int `json:"limit"`
Cursor string `json:"cursor"`
}
GetGroupMsgListV2Request 获取群发记录列表请求
type GetGroupMsgListV2Response ¶
type GetGroupMsgListV2Response struct {
util.CommonError
NextCursor string `json:"next_cursor"`
GroupMsgList []*GroupMsg `json:"group_msg_list"`
}
GetGroupMsgListV2Response 获取群发记录列表响应
type GetGroupMsgSendResultRequest ¶
type GetGroupMsgSendResultRequest struct {
MsgID string `json:"msgid"`
UserID string `json:"userid"`
Limit int `json:"limit"`
Cursor string `json:"cursor"`
}
GetGroupMsgSendResultRequest 获取企业群发成员执行结果请求
type GetGroupMsgSendResultResponse ¶
type GetGroupMsgSendResultResponse struct {
util.CommonError
NextCursor string `json:"next_cursor"`
SendList []*Send `json:"send_list"`
}
GetGroupMsgSendResultResponse 获取企业群发成员执行结果响应
type GetGroupMsgTaskRequest ¶
type GetGroupMsgTaskRequest struct {
MsgID string `json:"msgid"`
Limit int `json:"limit"`
Cursor string `json:"cursor"`
}
GetGroupMsgTaskRequest 获取群发成员发送任务列表请求
type GetGroupMsgTaskResponse ¶
type GetGroupMsgTaskResponse struct {
util.CommonError
NextCursor string `json:"next_cursor"`
TaskList []*Task `json:"task_list"`
}
GetGroupMsgTaskResponse 获取群发成员发送任务列表响应
type GetGroupWelcomeTemplateRequest ¶
type GetGroupWelcomeTemplateRequest struct {
TemplateID string `json:"template_id"`
}
GetGroupWelcomeTemplateRequest 获取入群欢迎语素材请求
type GetGroupWelcomeTemplateResponse ¶
type GetGroupWelcomeTemplateResponse struct {
util.CommonError
Text MsgText `json:"text"`
Image AttachmentImg `json:"image"`
Link AttachmentLink `json:"link"`
MiniProgram AttachmentMiniProgram `json:"miniprogram"`
File AttachmentFile `json:"file"`
Video AttachmentVideo `json:"video"`
}
GetGroupWelcomeTemplateResponse 获取入群欢迎语素材响应
type GetJoinWayResponse ¶
type GetJoinWayResponse struct {
util.CommonError
JoinWay JoinWay `json:"join_way"`
}
GetJoinWayResponse 获取群配置的返回值
type GetUserBehaviorRequest ¶
type GetUserBehaviorRequest struct {
UserID []string `json:"userid"`
PartyID []int `json:"partyid"`
StartTime int `json:"start_time"`
EndTime int `json:"end_time"`
}
GetUserBehaviorRequest 获取「联系客户统计」数据请求
type GetUserBehaviorResponse ¶
type GetUserBehaviorResponse struct {
util.CommonError
BehaviorData []BehaviorData `json:"behavior_data"`
}
GetUserBehaviorResponse 获取「联系客户统计」数据响应
type GroupChat ¶
type GroupChat struct {
ChatID string `json:"chat_id"` //客户群ID
Name string `json:"name"` //群名
Owner string `json:"owner"` //群主ID
CreateTime int `json:"create_time"` //群的创建时间
Notice string `json:"notice"` //群公告
MemberList []GroupChatMember `json:"member_list"` //群成员列表
AdminList []GroupChatAdmin `json:"admin_list"` //群管理员列表
}
GroupChat 客户群详情
type GroupChatAdmin ¶
type GroupChatAdmin struct {
UserID string `json:"userid"` //群管理员userid
}
GroupChatAdmin 群管理员
type GroupChatDetailRequest ¶
type GroupChatDetailRequest struct {
ChatID string `json:"chat_id"`
NeedName int `json:"need_name"`
}
GroupChatDetailRequest 客户群详情 请求参数
type GroupChatDetailResponse ¶
type GroupChatDetailResponse struct {
util.CommonError
GroupChat GroupChat `json:"group_chat"` //客户群详情
}
GroupChatDetailResponse 客户群详情 返回值
type GroupChatList ¶
GroupChatList 客户群列表
type GroupChatListRequest ¶
type GroupChatListRequest struct {
StatusFilter int `json:"status_filter"` // 非必填 客户群跟进状态过滤。0 - 所有列表(即不过滤) 1 - 离职待继承 2 - 离职继承中 3 - 离职继承完成
OwnerFilter OwnerFilter `json:"owner_filter"` //非必填 群主过滤。如果不填,表示获取应用可见范围内全部群主的数据(但是不建议这么用,如果可见范围人数超过1000人,为了防止数据包过大,会报错 81017)
Cursor string `json:"cursor"` //非必填 用于分页查询的游标,字符串类型,由上一次调用返回,首次调用不填
Limit int `json:"limit"` //必填 分页,预期请求的数据量,取值范围 1 ~ 1000
}
GroupChatListRequest 获取客户群列表的请求参数
type GroupChatListResponse ¶
type GroupChatListResponse struct {
util.CommonError
GroupChatList []GroupChatList `json:"group_chat_list"`
NextCursor string `json:"next_cursor"` //游标
}
GroupChatListResponse 获取客户群列表的返回值
type GroupChatMember ¶
type GroupChatMember struct {
UserID string `json:"userid"` //群成员id
Type int `json:"type"` //成员类型。 1 - 企业成员 2 - 外部联系人
JoinTime int `json:"join_time"` //入群时间
JoinScene int `json:"join_scene"` //入群方式 1 - 由群成员邀请入群(直接邀请入群) 2 - 由群成员邀请入群(通过邀请链接入群) 3 - 通过扫描群二维码入群
Invitor Invitor `json:"invitor,omitempty"` //邀请者。目前仅当是由本企业内部成员邀请入群时会返回该值
GroupNickname string `json:"group_nickname"` //在群里的昵称
Name string `json:"name"` //名字。仅当 need_name = 1 时返回 如果是微信用户,则返回其在微信中设置的名字 如果是企业微信联系人,则返回其设置对外展示的别名或实名
UnionID string `json:"unionid,omitempty"` //外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当群成员类型是微信用户(包括企业成员未添加好友),且企业绑定了微信开发者ID有此字段(查看绑定方法)。第三方不可获取,上游企业不可获取下游企业客户的unionid字段
}
GroupChatMember 群成员
type GroupChatStatItem ¶
type GroupChatStatItem struct {
Owner string `json:"owner"`
Data GroupChatStatItemData `json:"data"`
}
GroupChatStatItem 群聊数据统计(按群主聚合)条目
type GroupChatStatItemData ¶
type GroupChatStatItemData struct {
NewChatCnt int `json:"new_chat_cnt"`
ChatTotal int `json:"chat_total"`
ChatHasMsg int `json:"chat_has_msg"`
NewMemberCnt int `json:"new_member_cnt"`
MemberTotal int `json:"member_total"`
MemberHasMsg int `json:"member_has_msg"`
MsgTotal int `json:"msg_total"`
MigrateTraineeChatCnt int `json:"migrate_trainee_chat_cnt"`
}
GroupChatStatItemData 群聊数据统计条目数据
type GroupMsg ¶
type GroupMsg struct {
MsgID string `json:"msgid"`
Creator string `json:"creator"`
CreateTime int `json:"create_time"`
CreateType int `json:"create_type"`
Text MsgText `json:"text"`
Attachments []*Attachment `json:"attachments"`
}
GroupMsg 群发消息
type JoinWay ¶
type JoinWay struct {
ConfigID string `json:"config_id"`
Scene int `json:"scene"`
Remark string `json:"remark"`
AutoCreateRoom int `json:"auto_create_room"`
RoomBaseName string `json:"room_base_name"`
RoomBaseID int `json:"room_base_id"`
ChatIDList []string `json:"chat_id_list"`
QrCode string `json:"qr_code"`
State string `json:"state"`
}
JoinWay 群配置
type JoinWayConfigRequest ¶
type JoinWayConfigRequest struct {
ConfigID string `json:"config_id"`
}
JoinWayConfigRequest 获取或删除群配置的请求参数
type ListContactWayRequest ¶
type ListContactWayRequest struct {
StartTime int `json:"start_time"`
EndTime int `json:"end_time"`
Cursor string `json:"cursor"`
Limit int `json:"limit"`
}
ListContactWayRequest 获取企业已配置的「联系我」列表请求
type ListContactWayResponse ¶
type ListContactWayResponse struct {
util.CommonError
ContactWay []*ContactWayForList `json:"contact_way"`
NextCursor string `json:"next_cursor"`
}
ListContactWayResponse 获取企业已配置的「联系我」列表响应
type MarkTagRequest ¶
type MarkTagRequest struct {
UserID string `json:"userid"`
ExternalUserID string `json:"external_userid"`
AddTag []string `json:"add_tag"`
RemoveTag []string `json:"remove_tag"`
}
MarkTagRequest 给客户打标签请求 相关文档地址:https://developer.work.weixin.qq.com/document/path/92118
type OpengIDToChatIDRequest ¶
type OpengIDToChatIDRequest struct {
OpengID string `json:"opengid"`
}
OpengIDToChatIDRequest 客户群opengid转换 请求参数
type OpengIDToChatIDResponse ¶
type OpengIDToChatIDResponse struct {
util.CommonError
ChatID string `json:"chat_id"` //客户群ID
}
OpengIDToChatIDResponse 客户群opengid转换 返回值
type OwnerFilter ¶
type OwnerFilter struct {
UseridList []string `json:"userid_list"`
}
OwnerFilter 群主过滤
type 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"`
}
Send 企业群发成员执行结果
type SendWelcomeMsgRequest ¶
type SendWelcomeMsgRequest struct {
WelcomeCode string `json:"welcome_code"`
Text MsgText `json:"text"`
Attachments []*Attachment `json:"attachments"`
}
SendWelcomeMsgRequest 发送新客户欢迎语请求
type SendWelcomeMsgResponse ¶
type SendWelcomeMsgResponse struct {
util.CommonError
}
SendWelcomeMsgResponse 发送新客户欢迎语响应
type Tag ¶
type Tag struct {
GroupName string `json:"group_name"`
TagName string `json:"tag_name"`
Type int64 `json:"type"`
TagID string `json:"tag_id"`
}
Tag 已绑定在外部联系人的标签
type TagGroup ¶
type TagGroup struct {
GroupID string `json:"group_id"`
GroupName string `json:"group_name"`
CreateTime int `json:"create_time"`
GroupOrder int `json:"group_order"`
Deleted bool `json:"deleted"`
Tag []TagGroupTagItem `json:"tag"`
}
TagGroup 企业标签组
type TagGroupTagItem ¶
type TagGroupTagItem struct {
ID string `json:"id"`
Name string `json:"name"`
CreateTime int `json:"create_time"`
Order int `json:"order"`
Deleted bool `json:"deleted"`
}
TagGroupTagItem 企业标签内的子项
type Task ¶
type Task struct {
UserID string `json:"userid"`
Status int `json:"status"`
SendTime int `json:"send_time"`
}
Task 获取群发成员发送任务列表任务
type UpdateContactWayRequest ¶
type UpdateContactWayRequest struct {
ConfigID string `json:"config_id"`
Remark string `json:"remark"`
SkipVerify bool `json:"skip_verify"`
Style int `json:"style"`
State string `json:"state"`
User []string `json:"user"`
Party []int `json:"party"`
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
Conclusions ConclusionsRequest `json:"conclusions"`
}
UpdateContactWayRequest 更新企业已配置的「联系我」方式请求
type UpdateContactWayResponse ¶
type UpdateContactWayResponse struct {
util.CommonError
}
UpdateContactWayResponse 更新企业已配置的「联系我」方式响应
type UpdateJoinWayRequest ¶
type UpdateJoinWayRequest struct {
ConfigID string `json:"config_id"`
Scene int `json:"scene"` // 必填 1 - 群的小程序插件,2 - 群的二维码插件
Remark string `json:"remark"` //非必填 联系方式的备注信息,用于助记,超过30个字符将被截断
AutoCreateRoom int `json:"auto_create_room"` //非必填 当群满了后,是否自动新建群。0-否;1-是。 默认为1
RoomBaseName string `json:"room_base_name"` //非必填 自动建群的群名前缀,当auto_create_room为1时有效。最长40个utf8字符
RoomBaseID int `json:"room_base_id"` //非必填 自动建群的群起始序号,当auto_create_room为1时有效
ChatIDList []string `json:"chat_id_list"` //必填 使用该配置的客户群ID列表,支持5个。见客户群ID获取方法
State string `json:"state"` //非必填 企业自定义的state参数,用于区分不同的入群渠道。不超过30个UTF-8字符
}
UpdateJoinWayRequest 更新群配置的请求参数
type UpdateUserRemarkRequest ¶
type UpdateUserRemarkRequest struct {
UserID string `json:"userid"`
ExternalUserID string `json:"external_userid"`
Remark string `json:"remark"`
Description string `json:"description"`
RemarkCompany string `json:"remark_company"`
RemarkMobiles []string `json:"remark_mobiles"`
RemarkPicMediaID string `json:"remark_pic_mediaid"`
}
UpdateUserRemarkRequest 修改客户备注信息请求体
type WechatChannel ¶
WechatChannel 视频号添加的场景