wechat/work/externalcontact/customer_acquisition.go

package externalcontact

import (
	"fmt"

	"github.com/silenceper/wechat/v2/util"
)

const (
	// listLinkUrl 获取获客链接列表
	listLinkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/list_link?access_token=%s"
	// getCustomerAcquisition 获取获客链接详情
	getCustomerAcquisitionURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/get?access_token=%s"
	// createCustomerAcquisitionLink 创建获客链接
	createCustomerAcquisitionLinkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/create_link?access_token=%s"
	// updateCustomerAcquisitionLink 编辑获客链接
	updateCustomerAcquisitionLinkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/update_link?access_token=%s"
	// deleteCustomerAcquisitionLink 删除获客链接
	deleteCustomerAcquisitionLinkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/delete_link?access_token=%s"
	// getCustomerInfoWithCustomerAcquisitionLinkURL 获取由获客链接添加的客户信息
	getCustomerInfoWithCustomerAcquisitionLinkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/customer?access_token=%s"
	// customerAcquisitionQuota 查询剩余使用量
	customerAcquisitionQuotaURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition_quota?access_token=%s"
	// customerAcquisitionStatistic 查询链接使用详情
	customerAcquisitionStatisticURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/statistic?access_token=%s"
	// customerAcquisitionGetChatInfo 获取成员多次收消息详情
	customerAcquisitionGetChatInfoURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/get_chat_info?access_token=%s"
	// customerAcquisitionGetPermitURL 获取客户可建联成员
	customerAcquisitionGetPermitURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition_app/get_permit?access_token=%s"
)

type (
	// ListLinkRequest 获取获客链接列表请求
	ListLinkRequest struct {
		Limit  int    `json:"limit"`
		Cursor string `json:"cursor"`
	}
	// ListLinkResponse 获取获客链接列表响应
	ListLinkResponse struct {
		util.CommonError
		LinkIDList []string `json:"link_id_list"`
		NextCursor string   `json:"next_cursor"`
	}
)

// ListLink 获客助手--获取获客链接列表
// see https://developer.work.weixin.qq.com/document/path/97297
func (r *Client) ListLink(req *ListLinkRequest) (*ListLinkResponse, 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(listLinkURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &ListLinkResponse{}
	err = util.DecodeWithError(response, result, "ListLink")
	return result, err
}

type (
	// GetCustomerAcquisitionRequest 获取获客链接详情请求
	GetCustomerAcquisitionRequest struct {
		LinkID string `json:"link_id"`
	}
	// GetCustomerAcquisitionResponse 获取获客链接详情响应
	GetCustomerAcquisitionResponse struct {
		util.CommonError
		Link           Link                     `json:"link"`
		Range          CustomerAcquisitionRange `json:"range"`
		PriorityOption CustomerPriorityOption   `json:"priority_option"`
		SkipVerify     bool                     `json:"skip_verify"`
	}
	// Link 获客链接
	Link struct {
		LinkID     string `json:"link_id"`
		LinkName   string `json:"link_name"`
		URL        string `json:"url"`
		CreateTime int64  `json:"create_time"`
		SkipVerify bool   `json:"skip_verify"`
		MarkSource bool   `json:"mark_source"`
	}

	// CustomerAcquisitionRange 该获客链接使用范围
	CustomerAcquisitionRange struct {
		UserList       []string `json:"user_list"`
		DepartmentList []int64  `json:"department_list"`
	}

	// CustomerPriorityOption 该获客链接的优先选项
	CustomerPriorityOption struct {
		PriorityType       int      `json:"priority_type"`
		PriorityUseridList []string `json:"priority_userid_list"`
	}
)

// GetCustomerAcquisition 获客助手--获取获客链接详情
// see https://developer.work.weixin.qq.com/document/path/97297
func (r *Client) GetCustomerAcquisition(req *GetCustomerAcquisitionRequest) (*GetCustomerAcquisitionResponse, 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(getCustomerAcquisitionURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &GetCustomerAcquisitionResponse{}
	err = util.DecodeWithError(response, result, "GetCustomerAcquisition")
	return result, err
}

type (
	// CreateCustomerAcquisitionLinkRequest 创建获客链接请求
	CreateCustomerAcquisitionLinkRequest struct {
		LinkName       string                   `json:"link_name"`
		Range          CustomerAcquisitionRange `json:"range"`
		SkipVerify     bool                     `json:"skip_verify"`
		PriorityOption CustomerPriorityOption   `json:"priority_option"`
		MarkSource     bool                     `json:"mark_source"`
	}
	// CreateCustomerAcquisitionLinkResponse 创建获客链接响应
	CreateCustomerAcquisitionLinkResponse struct {
		util.CommonError
		Link Link `json:"link"`
	}
)

// CreateCustomerAcquisitionLink 获客助手--创建获客链接
// see https://developer.work.weixin.qq.com/document/path/97297
func (r *Client) CreateCustomerAcquisitionLink(req *CreateCustomerAcquisitionLinkRequest) (*CreateCustomerAcquisitionLinkResponse, 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(createCustomerAcquisitionLinkURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &CreateCustomerAcquisitionLinkResponse{}
	err = util.DecodeWithError(response, result, "CreateCustomerAcquisitionLink")
	return result, err
}

type (
	// UpdateCustomerAcquisitionLinkRequest 编辑获客链接请求
	UpdateCustomerAcquisitionLinkRequest struct {
		LinkID         string                   `json:"link_id"`
		LinkName       string                   `json:"link_name"`
		Range          CustomerAcquisitionRange `json:"range"`
		SkipVerify     bool                     `json:"skip_verify"`
		PriorityOption CustomerPriorityOption   `json:"priority_option"`
		MarkSource     bool                     `json:"mark_source"`
	}
	// UpdateCustomerAcquisitionLinkResponse 编辑获客链接响应
	UpdateCustomerAcquisitionLinkResponse struct {
		util.CommonError
	}
)

// UpdateCustomerAcquisitionLink 获客助手--编辑获客链接
// see https://developer.work.weixin.qq.com/document/path/97297
func (r *Client) UpdateCustomerAcquisitionLink(req *UpdateCustomerAcquisitionLinkRequest) (*UpdateCustomerAcquisitionLinkResponse, 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(updateCustomerAcquisitionLinkURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &UpdateCustomerAcquisitionLinkResponse{}
	err = util.DecodeWithError(response, result, "UpdateCustomerAcquisitionLink")
	return result, err
}

type (
	// DeleteCustomerAcquisitionLinkRequest 删除获客链接请求
	DeleteCustomerAcquisitionLinkRequest struct {
		LinkID string `json:"link_id"`
	}
	// DeleteCustomerAcquisitionLinkResponse 删除获客链接响应
	DeleteCustomerAcquisitionLinkResponse struct {
		util.CommonError
	}
)

// DeleteCustomerAcquisitionLink 获客助手--删除获客链接
// see https://developer.work.weixin.qq.com/document/path/97297
func (r *Client) DeleteCustomerAcquisitionLink(req *DeleteCustomerAcquisitionLinkRequest) (*DeleteCustomerAcquisitionLinkResponse, 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(deleteCustomerAcquisitionLinkURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &DeleteCustomerAcquisitionLinkResponse{}
	err = util.DecodeWithError(response, result, "DeleteCustomerAcquisitionLink")
	return result, err
}

type (
	// GetCustomerInfoWithCustomerAcquisitionLinkRequest 获取由获客链接添加的客户信息请求
	GetCustomerInfoWithCustomerAcquisitionLinkRequest struct {
		LinkID string `json:"link_id"`
		Limit  int64  `json:"limit"`
		Cursor string `json:"cursor"`
	}
	// GetCustomerInfoWithCustomerAcquisitionLinkResponse 获取由获客链接添加的客户信息响应
	GetCustomerInfoWithCustomerAcquisitionLinkResponse struct {
		util.CommonError
		CustomerList []CustomerList `json:"customer_list"`
		NextCursor   string         `json:"next_cursor"`
	}
	// CustomerList 客户列表
	CustomerList struct {
		ExternalUserid string `json:"external_userid"`
		Userid         string `json:"userid"`
		ChatStatus     int64  `json:"chat_status"`
		State          string `json:"state"`
	}
)

// GetCustomerInfoWithCustomerAcquisitionLink 获客助手--获取由获客链接添加的客户信息
// see https://developer.work.weixin.qq.com/document/path/97298
func (r *Client) GetCustomerInfoWithCustomerAcquisitionLink(req *GetCustomerInfoWithCustomerAcquisitionLinkRequest) (*GetCustomerInfoWithCustomerAcquisitionLinkResponse, 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(getCustomerInfoWithCustomerAcquisitionLinkURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &GetCustomerInfoWithCustomerAcquisitionLinkResponse{}
	err = util.DecodeWithError(response, result, "GetCustomerInfoWithCustomerAcquisitionLink")
	return result, err
}

type (
	// CustomerAcquisitionQuotaResponse 查询剩余使用量响应
	CustomerAcquisitionQuotaResponse struct {
		util.CommonError
		Total     int64       `json:"total"`
		Balance   int64       `json:"balance"`
		QuotaList []QuotaList `json:"quota_list"`
	}
	// QuotaList 额度
	QuotaList struct {
		ExpireDate int64 `json:"expire_date"`
		Balance    int64 `json:"balance"`
	}
)

// CustomerAcquisitionQuota 获客助手额度管理与使用统计--查询剩余使用量
// see https://developer.work.weixin.qq.com/document/path/97375
func (r *Client) CustomerAcquisitionQuota() (*CustomerAcquisitionQuotaResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.HTTPGet(fmt.Sprintf(customerAcquisitionQuotaURL, accessToken)); err != nil {
		return nil, err
	}
	result := &CustomerAcquisitionQuotaResponse{}
	err = util.DecodeWithError(response, result, "CustomerAcquisitionQuota")
	return result, err
}

type (
	// CustomerAcquisitionStatisticRequest 查询链接使用详情请求
	CustomerAcquisitionStatisticRequest struct {
		LinkID    string `json:"link_id"`
		StartTime int64  `json:"start_time"`
		EndTime   int64  `json:"end_time"`
	}
	// CustomerAcquisitionStatisticResponse 查询链接使用详情响应
	CustomerAcquisitionStatisticResponse struct {
		util.CommonError
		ClickLinkCustomerCnt int64 `json:"click_link_customer_cnt"`
		NewCustomerCnt       int64 `json:"new_customer_cnt"`
	}
)

// CustomerAcquisitionStatistic 获客助手额度管理与使用统计--查询链接使用详情
// see https://developer.work.weixin.qq.com/document/path/97375
func (r *Client) CustomerAcquisitionStatistic(req *CustomerAcquisitionStatisticRequest) (*CustomerAcquisitionStatisticResponse, 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(customerAcquisitionStatisticURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &CustomerAcquisitionStatisticResponse{}
	err = util.DecodeWithError(response, result, "CustomerAcquisitionStatistic")
	return result, err
}

type (
	// GetChatInfoRequest 获取成员多次收消息详情请求
	GetChatInfoRequest struct {
		ChatKey string `json:"chat_key"`
	}
	// GetChatInfoResponse 获取成员多次收消息详情响应
	GetChatInfoResponse struct {
		util.CommonError
		UserID         string   `json:"userid"`
		ExternalUserID string   `json:"external_userid"`
		ChatInfo       ChatInfo `json:"chat_info"`
	}
	// ChatInfo 聊天信息
	ChatInfo struct {
		RecvMsgCnt int64  `json:"recv_msg_cnt"` // 成员收到的此客户的消息次数
		LinkID     string `json:"link_id"`      // 成员添加客户的获客链接id
		State      string `json:"state"`        // 成员添加客户的state
	}
)

// GetChatInfo 获取成员多次收消息详情
// see https://developer.work.weixin.qq.com/document/path/100130
func (r *Client) GetChatInfo(req *GetChatInfoRequest) (*GetChatInfoResponse, 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(customerAcquisitionGetChatInfoURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &GetChatInfoResponse{}
	err = util.DecodeWithError(response, result, "GetChatInfo")
	return result, err
}

// GetPermitResponse 获取客户可建联成员响应
type GetPermitResponse struct {
	util.CommonError
	UserList       []string `json:"user_list"`
	DepartmentList []int    `json:"department_list"`
	TagList        []int    `json:"tag_list"`
}

// GetPermit 获取客户可建联成员
// see https://developer.work.weixin.qq.com/document/path/101146
func (r *Client) GetPermit() (*GetPermitResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.HTTPGet(fmt.Sprintf(customerAcquisitionGetPermitURL, accessToken)); err != nil {
		return nil, err
	}
	result := &GetPermitResponse{}
	err = util.DecodeWithError(response, result, "CustomerAcquisitionGetPermit")
	return result, err
}