externalcontact

package
v2.1.4-rc.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 8, 2022 License: Apache-2.0 Imports: 4 Imported by: 2

README

企业微信 客户联系部分

相关文档正在梳理中...

Documentation

Index

Constants

View Source 
const (
	// FetchExternalContactUserListURL 获取客户列表
	FetchExternalContactUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list"
	// FetchExternalContactUserDetailURL 获取客户详情
	FetchExternalContactUserDetailURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get"
	// FetchBatchExternalContactUserDetailURL 批量获取客户详情
	FetchBatchExternalContactUserDetailURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch/get_by_user"
	// UpdateUserRemarkURL 更新客户备注信息
	UpdateUserRemarkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remark"
)
View Source 
const (
	// GetUserBehaviorDataURL 获取「联系客户统计」数据
	GetUserBehaviorDataURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_user_behavior_data"
	// GetGroupChatStatURL 获取「群聊数据统计」数据 按群主聚合的方式
	GetGroupChatStatURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/statistic"
	// GetGroupChatStatByDayURL 获取「群聊数据统计」数据 按自然日聚合的方式
	GetGroupChatStatByDayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/statistic_group_by_day"
)
View Source 
const (
	// GetCropTagURL 获取标签列表
	GetCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list"
	// AddCropTagURL 添加标签
	AddCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag"
	// EditCropTagURL 修改标签
	EditCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag"
	// DelCropTagURL 删除标签
	DelCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag"
	// MarkCropTagURL 为客户打上、删除标签
	MarkCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag"
)
View Source 
const (
	// FetchFollowUserListURL 获取配置了客户联系功能的成员列表
	FetchFollowUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_follow_user_list"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddCropTagItem 

type AddCropTagItem struct {
	Name  string `json:"name"`
	Order int    `json:"order"`
}

AddCropTagItem 添加企业标签子项

type AddCropTagRequest 

type AddCropTagRequest struct {
	GroupID   string           `json:"group_id"`
	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 BatchGetExternalUserDetailsRequest 

type BatchGetExternalUserDetailsRequest struct {
	UserIDList []string `json:"userid_list"`
	Cursor     string   `json:"cursor"`
}

BatchGetExternalUserDetailsRequest 批量获取外部联系人详情请求

type BehaviorData added in v2.1.4 

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 

type Client struct {
	*context.Context
}

Client 外部联系接口实例

func NewClient 

func NewClient(ctx *context.Context) *Client

NewClient 初始化实例

func (*Client) AddCropTag 

func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error)

AddCropTag 添加企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117

func (*Client) BatchGetExternalUserDetails 

func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUser, error)

BatchGetExternalUserDetails 批量获取外部联系人详情

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) 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) (*ExternalUser, error)

GetExternalUserDetail 获取外部联系人详情

func (*Client) GetExternalUserList 

func (r *Client) GetExternalUserList(userID string) ([]string, error)

GetExternalUserList 获取客户列表 @see https://developer.work.weixin.qq.com/document/path/92113

func (*Client) GetFollowUserList 

func (r *Client) GetFollowUserList() ([]string, error)

GetFollowUserList 获取配置了客户联系功能的成员列表 @see https://developer.work.weixin.qq.com/document/path/92571

func (*Client) GetGroupChatStat added in v2.1.4 

func (r *Client) GetGroupChatStat(req *GetGroupChatStatRequest) (*GetGroupChatStatResponse, error)

GetGroupChatStat 获取「群聊数据统计」数据 按群主聚合的方式 @see https://developer.work.weixin.qq.com/document/path/92133

func (*Client) GetGroupChatStatByDay added in v2.1.4 

func (r *Client) GetGroupChatStatByDay(req *GetGroupChatStatByDayRequest) ([]GetGroupChatStatByDayItem, error)

GetGroupChatStatByDay 获取「群聊数据统计」数据 按自然日聚合的方式 @see https://developer.work.weixin.qq.com/document/path/92133

func (*Client) GetUserBehaviorData added in v2.1.4 

func (r *Client) GetUserBehaviorData(req *GetUserBehaviorRequest) ([]BehaviorData, error)

GetUserBehaviorData 获取「联系客户统计」数据 @see https://developer.work.weixin.qq.com/document/path/92132

func (*Client) MarkTag 

func (r *Client) MarkTag(request MarkTagRequest) error

MarkTag 为客户打上标签 @see https://developer.work.weixin.qq.com/document/path/92118

func (*Client) UpdateUserRemark 

func (r *Client) UpdateUserRemark(request UpdateUserRemarkRequest) error

UpdateUserRemark 修改客户备注信息

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 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"`
	FollowUser      []FollowUser `json:"follow_user"`
	NextCursor      string       `json:"next_cursor"`
}

ExternalUser 外部联系人

type ExternalUserDetailListResponse 

type ExternalUserDetailListResponse struct {
	util.CommonError
	ExternalContactList []ExternalUser `json:"external_contact_list"`
}

ExternalUserDetailListResponse 批量获取外部联系人详情响应

type ExternalUserDetailResponse 

type ExternalUserDetailResponse struct {
	util.CommonError
	ExternalUser
}

ExternalUserDetailResponse 外部联系人详情响应

type ExternalUserListResponse 

type ExternalUserListResponse struct {
	util.CommonError
	ExternalUserID []string `json:"external_userid"`
}

ExternalUserListResponse 外部联系人列表响应

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 GetCropTagListResponse 

type GetCropTagListResponse struct {
	util.CommonError
	TagGroup []TagGroup `json:"tag_group"`
}

GetCropTagListResponse 获取企业标签列表响应

type GetCropTagRequest 

type GetCropTagRequest struct {
	TagID   []string `json:"tag_id"`
	GroupID []string `json:"group_id"`
}

GetCropTagRequest 获取企业标签请求

type GetGroupChatStatByDayItem added in v2.1.4 

type GetGroupChatStatByDayItem struct {
	StatTime int                   `json:"stat_time"`
	Data     GroupChatStatItemData `json:"data"`
}

GetGroupChatStatByDayItem 群聊数据统计(按自然日聚合)条目

type GetGroupChatStatByDayRequest added in v2.1.4 

type GetGroupChatStatByDayRequest struct {
	DayBeginTime int         `json:"day_begin_time"`
	DayEndTime   int         `json:"day_end_time"`
	OwnerFilter  OwnerFilter `json:"owner_filter"`
}

GetGroupChatStatByDayRequest 获取「群聊数据统计」数据 按自然日聚合的方式 请求

type GetGroupChatStatByDayResponse added in v2.1.4 

type GetGroupChatStatByDayResponse struct {
	util.CommonError
	Items []GetGroupChatStatByDayItem `json:"items"`
}

GetGroupChatStatByDayResponse 获取「群聊数据统计」数据 按自然日聚合的方式 响应

type GetGroupChatStatRequest added in v2.1.4 

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 added in v2.1.4 

type GetGroupChatStatResponse struct {
	util.CommonError
	Total      int                 `json:"total"`
	NextOffset int                 `json:"next_offset"`
	Items      []GroupChatStatItem `json:"items"`
}

GetGroupChatStatResponse 获取「群聊数据统计」数据 按群主聚合的方式 响应

type GetUserBehaviorRequest added in v2.1.4 

type GetUserBehaviorRequest struct {
	UserID    []string `json:"userid"`
	PartyID   []int    `json:"partyid"`
	StartTime int      `json:"start_time"`
	EndTime   int      `json:"end_time"`
}

GetUserBehaviorRequest 获取「联系客户统计」数据请求

type GetUserBehaviorResponse added in v2.1.4 

type GetUserBehaviorResponse struct {
	util.CommonError
	BehaviorData []BehaviorData `json:"behavior_data"`
}

GetUserBehaviorResponse 获取「联系客户统计」数据响应

type GroupChatStatItem added in v2.1.4 

type GroupChatStatItem struct {
	Owner string                `json:"owner"`
	Data  GroupChatStatItemData `json:"data"`
}

GroupChatStatItem 群聊数据统计(按群主聚合)条目

type GroupChatStatItemData added in v2.1.4 

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 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 OwnerFilter added in v2.1.4 

type OwnerFilter struct {
	UseridList []string `json:"userid_list"`
}

OwnerFilter 群主过滤

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 string            `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 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 

type WechatChannel struct {
	NickName string `json:"nickname"`
	Source   string `json:"source"`
}

WechatChannel 视频号添加的场景

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.