1
0
mirror of https://github.com/silenceper/wechat.git synced 2026-02-23 13:42:25 +08:00

Compare commits

..

10 Commits

Author SHA1 Message Date
houseme
d1cee8868e feat: add order setter relation 2023-09-22 18:08:40 +08:00
houseme
aa1afc5a35 improve code 2023-09-22 17:28:17 +08:00
markwang
9e810be88a feat:企业微信-微信客服-知识库 (#715)
* feat:企业微信-微信客服=知识库

* fix:golangci-lint

* fix:移除非必要的err判断

---------

Co-authored-by: markwang <www.wang61@qq.com>
2023-09-04 20:15:13 +08:00
markwang
06719f77b7 feat:企业微信-微信客服-统计管理 (#707)
Co-authored-by: markwang <www.wang61@qq.com>
2023-08-31 14:36:22 +08:00
markwang
b70ecd93a7 feat:企业微信-消息推送新增接口 (#705)
Co-authored-by: markwang <www.wang61@qq.com>
2023-08-31 14:34:13 +08:00
ccfish
dea33e0e48 小程序消息推送 (#713)
* 小程序消息推送

* fix lint errors

* fix lint

* fix lint

* fix lint,

* 简化写法

* fix 简化写法

* fix name in comments

* add events

* change GoodsInfo type

* change statements to 50

* 追加xml支持

* fix cl lint
2023-08-27 19:13:00 +08:00
ccfish
e02af1dc0f 小程序发货信息管理 (#710)
* 小程序发货信息管理

* fix golang lint

* fix miss

* fix lint

* fix lint

* fix lint

* 修复查询参数last_index=“”时异常

* Update miniprogram.go
2023-08-27 11:25:05 +08:00
曹晶
c81d0b1215 feat: 企业微信-客户联系-获客助手 (#704) 2023-08-25 18:28:21 +08:00
Feng
da80430065 feat: Add APIs for User and Department (#712) 2023-08-25 18:27:30 +08:00
houseme
cc201fcece feat: create Mini Program entertainment mini-drama related interface (#711) 2023-08-25 18:02:46 +08:00
21 changed files with 2708 additions and 86 deletions

View File

@@ -55,7 +55,7 @@ issues:
linters-settings:
funlen:
lines: 66
statements: 40
statements: 50
#issues:
# include:

View File

@@ -21,7 +21,7 @@ miniprogram.GetAnalysis().GetAnalysisDailyRetain()
```
### 小程序虚拟支付
#### `注意:需要传入 Appkey 的值`
#### `注意:需要传入 Appkey、OfferID 的值`
相关文档:[小程序虚拟支付](https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/virtual-payment.html)
```go
wc := wechat.NewWechat()
@@ -29,6 +29,7 @@ miniprogram := wc.GetMiniProgram(&miniConfig.Config{
AppID: "xxx",
AppSecret: "xxx",
AppKey: "xxx",
OfferID: "xxx",
Cache: cache.NewRedis(&redis.Options{
Addr: "",
}),

View File

@@ -15,6 +15,8 @@ const (
checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s"
getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
checkSessionURL = "https://api.weixin.qq.com/wxa/checksession?access_token=%s&openid=%s&signature=%s&sig_method=hmac_sha256"
)
// Auth 登录/用户信息
@@ -33,7 +35,7 @@ type ResCode2Session struct {
OpenID string `json:"openid"` // 用户唯一标识
SessionKey string `json:"session_key"` // 会话密钥
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符,在满足 UnionID 下发条件的情况下会返回
}
// RspCheckEncryptedData .
@@ -70,12 +72,12 @@ func (auth *Auth) GetPaidUnionID() {
// TODO
}
// CheckEncryptedData .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据
// CheckEncryptedData .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近 3 天生成的加密数据
func (auth *Auth) CheckEncryptedData(encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
return auth.CheckEncryptedDataContext(context2.Background(), encryptedMsgHash)
}
// CheckEncryptedDataContext .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据
// CheckEncryptedDataContext .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近 3 天生成的加密数据
func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
var response []byte
var (
@@ -85,7 +87,7 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
return
}
// 由于GetPhoneNumberContext需要传入JSON所以HTTPPostContext入参改为[]byte
// 由于 GetPhoneNumberContext 需要传入 JSON所以 HTTPPostContext 入参改为 []byte
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), []byte("encrypted_msg_hash="+encryptedMsgHash), nil); err != nil {
return
}
@@ -113,38 +115,62 @@ type PhoneInfo struct {
} `json:"watermark"` // 数据水印
}
// GetPhoneNumberContext 小程序通过code获取用户手机号
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*GetPhoneNumberResponse, error) {
var response []byte
var (
at string
err error
)
if at, err = auth.GetAccessToken(); err != nil {
// GetPhoneNumberContext 小程序通过 code 获取用户手机号
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (result *GetPhoneNumberResponse, err error) {
var accessToken string
if accessToken, err = auth.GetAccessToken(); err != nil {
return nil, err
}
body := map[string]interface{}{
"code": code,
}
bodyBytes, err := json.Marshal(body)
bodyBytes, err := json.Marshal(map[string]interface{}{
"code": code,
})
if err != nil {
return nil, err
}
header := map[string]string{"Content-Type": "application/json;charset=utf-8"}
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, at), bodyBytes, header); err != nil {
var (
header = map[string]string{"Content-Type": "application/json;charset=utf-8"}
response []byte
)
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, accessToken), bodyBytes, header); err != nil {
return nil, err
}
var result GetPhoneNumberResponse
if err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber"); err != nil {
return nil, err
}
return &result, nil
err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber")
return
}
// GetPhoneNumber 小程序通过code获取用户手机号
// GetPhoneNumber 小程序通过 code 获取用户手机号
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
return auth.GetPhoneNumberContext(context2.Background(), code)
}
// // CheckSession 检验登录态是否过期。
// func (auth *Auth) CheckSession(sessionKey, openID string) (result *CheckSessionResponse, err error) {
// return auth.CheckSessionContext(context2.Background(), sessionKey, openID)
// }
//
// // CheckSessionContext 检验登录态是否过期。
// func (auth *Auth) CheckSessionContext(ctx context2.Context, sessionKey, openID string) (result *CheckSessionResponse, err error) {
// var accessToken string
// if accessToken, err = auth.GetAccessToken(); err != nil {
// return nil, err
// }
// var (
// response []byte
// signature string = sessionKey
// )
// if response, err = util.HTTPGetContext(ctx, fmt.Sprintf(checkSessionURL, accessToken, openID, signature)); err != nil {
// return nil, err
// }
//
// err = util.DecodeWithError(response, &result, "CheckSessionContext")
// return
// }
//
// // CheckSessionResponse 检验登录态是否过期。
// type CheckSessionResponse struct {
// util.CommonError
// }

View File

@@ -7,8 +7,11 @@ import (
// Config .config for 小程序
type Config struct {
AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` // appSecret
AppKey string `json:"app_key"` // appKey
Cache cache.Cache
AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` // appSecret
AppKey string `json:"app_key"` // appKey
OfferID string `json:"offer_id"` // offerId
Token string `json:"token"` // token
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
Cache cache.Cache
}

View File

@@ -20,6 +20,12 @@ const (
MsgTypeLink = "link"
// MsgTypeMiniProgramPage 小程序卡片
MsgTypeMiniProgramPage = "miniprogrampage"
// MsgTypeEvent 事件
MsgTypeEvent MsgType = "event"
// DataTypeXML XML格式数据
DataTypeXML = "xml"
// DataTypeJSON JSON格式数据
DataTypeJSON = "json"
)
// CommonToken 消息中通用的结构

View File

@@ -0,0 +1,375 @@
package message
import (
"encoding/json"
"encoding/xml"
"errors"
"io"
"net/http"
"sort"
"strings"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/security"
"github.com/silenceper/wechat/v2/util"
)
// ConfirmReceiveMethod 确认收货方式
type ConfirmReceiveMethod int8
const (
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务API
// 小程序完成账期授权时/小程序产生第一笔交易时/已产生交易但从未发货的小程序,每天一次
EventTypeTradeManageRemindAccessAPI EventType = "trade_manage_remind_access_api"
// EventTypeTradeManageRemindShipping 提醒需要上传发货信息
// 曾经发过货的小程序订单超过48小时未发货时
EventTypeTradeManageRemindShipping EventType = "trade_manage_remind_shipping"
// EventTypeTradeManageOrderSettlement 订单将要结算或已经结算
// 订单完成发货时/订单结算时
EventTypeTradeManageOrderSettlement EventType = "trade_manage_order_settlement"
// EventTypeAddExpressPath 运单轨迹更新事件
EventTypeAddExpressPath EventType = "add_express_path"
// EventTypeSecvodUpload 短剧媒资上传完成事件
EventTypeSecvodUpload EventType = "secvod_upload_event"
// EventTypeSecvodAudit 短剧媒资审核状态事件
EventTypeSecvodAudit EventType = "secvod_audit_event"
// EventTypeWxaMediaCheck 媒体内容安全异步审查结果通知
EventTypeWxaMediaCheck EventType = "wxa_media_check"
// EventTypeXpayGoodsDeliverNotify 道具发货推送事件
EventTypeXpayGoodsDeliverNotify EventType = "xpay_goods_deliver_notify"
// EventTypeXpayCoinPayNotify 代币支付推送事件
EventTypeXpayCoinPayNotify EventType = "xpay_coin_pay_notify"
// ConfirmReceiveMethodAuto 自动确认收货
ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1
// ConfirmReceiveMethodManual 手动确认收货
ConfirmReceiveMethodManual ConfirmReceiveMethod = 2
)
// PushReceiver 接收消息推送
// 暂仅支付Aes加密方式
type PushReceiver struct {
*context.Context
}
// NewPushReceiver 实例化
func NewPushReceiver(ctx *context.Context) *PushReceiver {
return &PushReceiver{
Context: ctx,
}
}
// GetMsg 获取接收到的消息(如果是加密的返回解密数据)
func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
// 判断请求格式
var dataType string
contentType := r.Header.Get("Content-Type")
if strings.HasPrefix(contentType, "text/xml") {
// xml格式
dataType = DataTypeXML
} else {
// json格式
dataType = DataTypeJSON
}
// 读取参数,验证签名
signature := r.FormValue("signature")
timestamp := r.FormValue("timestamp")
nonce := r.FormValue("nonce")
encryptType := r.FormValue("encrypt_type")
// 验证签名
tmpArr := []string{
receiver.Token,
timestamp,
nonce,
}
sort.Strings(tmpArr)
tmpSignature := util.Signature(tmpArr...)
if tmpSignature != signature {
return dataType, nil, errors.New("signature error")
}
if encryptType == "aes" {
// 解密
var reqData DataReceived
if dataType == DataTypeXML {
if err := xml.NewDecoder(r.Body).Decode(&reqData); err != nil {
return dataType, nil, err
}
} else {
if err := json.NewDecoder(r.Body).Decode(&reqData); err != nil {
return dataType, nil, err
}
}
_, rawMsgBytes, err := util.DecryptMsg(receiver.AppID, reqData.Encrypt, receiver.EncodingAESKey)
return dataType, rawMsgBytes, err
}
// 不加密
byteData, err := io.ReadAll(r.Body)
return dataType, byteData, err
}
// GetMsgData 获取接收到的消息(解密数据)
func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, PushData, error) {
dataType, decryptMsg, err := receiver.GetMsg(r)
if err != nil {
return "", "", nil, err
}
var (
msgType MsgType
eventType EventType
)
if dataType == DataTypeXML {
var commonToken CommonPushData
if err := xml.Unmarshal(decryptMsg, &commonToken); err != nil {
return "", "", nil, err
}
msgType, eventType = commonToken.MsgType, commonToken.Event
} else {
var commonToken CommonPushData
if err := json.Unmarshal(decryptMsg, &commonToken); err != nil {
return "", "", nil, err
}
msgType, eventType = commonToken.MsgType, commonToken.Event
}
if msgType == MsgTypeEvent {
pushData, err := receiver.getEvent(dataType, eventType, decryptMsg)
// 暂不支持其他事件类型
return msgType, eventType, pushData, err
}
// 暂不支持其他消息类型
return msgType, eventType, decryptMsg, nil
}
// getEvent 获取事件推送的数据
func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, decryptMsg []byte) (PushData, error) {
switch eventType {
case EventTypeTradeManageRemindAccessAPI:
// 提醒接入发货信息管理服务API
var pushData PushDataRemindAccessAPI
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeTradeManageRemindShipping:
// 提醒需要上传发货信息
var pushData PushDataRemindShipping
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeTradeManageOrderSettlement:
// 订单将要结算或已经结算
var pushData PushDataOrderSettlement
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeWxaMediaCheck:
// 媒体内容安全异步审查结果通知
var pushData MediaCheckAsyncData
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeAddExpressPath:
// 运单轨迹更新
var pushData PushDataAddExpressPath
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeSecvodUpload:
// 短剧媒资上传完成
var pushData PushDataSecVodUpload
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeSecvodAudit:
// 短剧媒资审核状态
var pushData PushDataSecVodAudit
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeXpayGoodsDeliverNotify:
// 道具发货推送事件
var pushData PushDataXpayGoodsDeliverNotify
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeXpayCoinPayNotify:
// 代币支付推送事件
var pushData PushDataXpayCoinPayNotify
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
}
// 暂不支持其他事件类型,直接返回解密后的数据,由调用方处理
return decryptMsg, nil
}
// unmarshal 解析推送的数据
func (receiver *PushReceiver) unmarshal(dateType string, decryptMsg []byte, pushData interface{}) error {
if dateType == DataTypeXML {
return xml.Unmarshal(decryptMsg, pushData)
}
return json.Unmarshal(decryptMsg, pushData)
}
// DataReceived 接收到的数据
type DataReceived struct {
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
}
// PushData 推送的数据(已转对应的结构体)
type PushData interface{}
// CommonPushData 推送数据通用部分
type CommonPushData struct {
XMLName xml.Name `json:"-" xml:"xml"`
MsgType MsgType `json:"MsgType" xml:"MsgType"` // 消息类型,为固定值 "event"
Event EventType `json:"Event" xml:"Event"` // 事件类型
ToUserName string `json:"ToUserName" xml:"ToUserName"` // 小程序的原始 ID
FromUserName string `json:"FromUserName" xml:"FromUserName"` // 发送方账号(一个 OpenID此时发送方是系统账号
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间 (整型),时间戳
}
// MediaCheckAsyncData 媒体内容安全异步审查结果通知
type MediaCheckAsyncData struct {
CommonPushData
Appid string `json:"appid" xml:"appid"`
TraceID string `json:"trace_id" xml:"trace_id"`
Version int `json:"version" xml:"version"`
Detail []*MediaCheckDetail `json:"detail" xml:"detail"`
Errcode int `json:"errcode" xml:"errcode"`
Errmsg string `json:"errmsg" xml:"errmsg"`
Result MediaCheckAsyncResult `json:"result" xml:"result"`
}
// MediaCheckDetail 检测结果详情
type MediaCheckDetail struct {
Strategy string `json:"strategy" xml:"strategy"`
Errcode int `json:"errcode" xml:"errcode"`
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
Label int `json:"label" xml:"label"`
Prob int `json:"prob" xml:"prob"`
}
// MediaCheckAsyncResult 检测结果
type MediaCheckAsyncResult struct {
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
Label security.CheckLabel `json:"label" xml:"label"`
}
// PushDataOrderSettlement 订单将要结算或已经结算通知
type PushDataOrderSettlement struct {
CommonPushData
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 支付订单号
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
ShippedTime int64 `json:"shipped_time" xml:"shipped_time"` // 发货时间,秒级时间戳
EstimatedSettlementTime int64 `json:"estimated_settlement_time" xml:"estimated_settlement_time"` // 预计结算时间,秒级时间戳。发货时推送才有该字段
ConfirmReceiveMethod ConfirmReceiveMethod `json:"confirm_receive_method" xml:"confirm_receive_method"` // 确认收货方式1. 自动确认收货2. 手动确认收货。结算时推送才有该字段
ConfirmReceiveTime int64 `json:"confirm_receive_time" xml:"confirm_receive_time"` // 确认收货时间,秒级时间戳。结算时推送才有该字段
SettlementTime int64 `json:"settlement_time" xml:"settlement_time"` // 订单结算时间,秒级时间戳。结算时推送才有该字段
}
// PushDataRemindShipping 提醒需要上传发货信息
type PushDataRemindShipping struct {
CommonPushData
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 微信支付订单号
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
// PushDataRemindAccessAPI 提醒接入发货信息管理服务API信息
type PushDataRemindAccessAPI struct {
CommonPushData
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
// PushDataAddExpressPath 运单轨迹更新信息
type PushDataAddExpressPath struct {
CommonPushData
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司ID
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单ID
OrderID string `json:"OrderId" xml:"OrderId"` // 订单ID
Version int `json:"Version" xml:"Version"` // 轨迹版本号(整型)
Count int `json:"Count" xml:"Count"` // 轨迹节点数(整型)
Actions []*PushDataAddExpressPathAction `json:"Actions" xml:"Actions"` // 轨迹节点列表
}
// PushDataAddExpressPathAction 轨迹节点
type PushDataAddExpressPathAction struct {
ActionTime int64 `json:"ActionTime" xml:"ActionTime"` // 轨迹节点 Unix 时间戳
ActionType int `json:"ActionType" xml:"ActionType"` // 轨迹节点类型
ActionMsg string `json:"ActionMsg" xml:"ActionMsg"` // 轨迹节点详情
}
// PushDataSecVodUpload 短剧媒资上传完成
type PushDataSecVodUpload struct {
CommonPushData
UploadEvent SecVodUploadEvent `json:"upload_event" xml:"upload_event"` // 上传完成事件
}
// SecVodUploadEvent 短剧媒资上传完成事件
type SecVodUploadEvent struct {
MediaID string `json:"media_id" xml:"media_id"` // 媒资id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值。
Errcode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
Errmsg string `json:"errmsg" xml:"errmsg"` // 错误提示
}
// PushDataSecVodAudit 短剧媒资审核状态
type PushDataSecVodAudit struct {
CommonPushData
AuditEvent SecVodAuditEvent `json:"audit_event" xml:"audit_event"` // 审核状态事件
}
// SecVodAuditEvent 短剧媒资审核状态事件
type SecVodAuditEvent struct {
DramaID string `json:"drama_id" xml:"drama_id"` // 剧目id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果单独每一集的审核结果可以根据drama_id查询剧集详情得到
}
// DramaAuditDetail 剧目审核结果
type DramaAuditDetail struct {
Status int `json:"status" xml:"status"` // 审核状态0为无效值1为审核中2为最终失败3为审核通过4为驳回重填
CreateTime int64 `json:"create_time" xml:"create_time"` // 提审时间戳
AuditTime int64 `json:"audit_time" xml:"audit_time"` // 审核时间戳
}
// PushDataXpayGoodsDeliverNotify 道具发货推送
type PushDataXpayGoodsDeliverNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` //,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
GoodsInfo GoodsInfo `json:"GoodsInfo" xml:"GoodsInfo"` // 道具参数信息
}
// WeChatPayInfo 微信支付信息
type WeChatPayInfo struct {
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间Linux秒级时间戳
}
// GoodsInfo 道具参数信息
type GoodsInfo struct {
ProductID string `json:"ProductId" xml:"ProductId"` // 道具ID
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格 (单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}
// PushDataXpayCoinPayNotify 代币支付推送
type PushDataXpayCoinPayNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` //,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
CoinInfo CoinInfo `json:"CoinInfo" xml:"CoinInfo"` // 代币参数信息
}
// CoinInfo 代币参数信息
type CoinInfo struct {
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格 (单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}

View File

@@ -0,0 +1,100 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
const (
// Success 错误码 0、成功
Success ErrCode = 0
// SystemError 错误码 -1、系统错误
SystemError ErrCode = -1
// InitError 错误码 -2 初始化未完成,请稍后再试
InitError ErrCode = -2
// FormatError 错误码 47001 输入格式错误
FormatError ErrCode = 47001
// ParamError 错误码 47003 参数不符合要求
ParamError ErrCode = 47003
// PostError 错误码 44002 POST 内容为空
PostError ErrCode = 44002
// MethodError 错误码 43002 HTTP 请求必须使用 POST 方法
MethodError ErrCode = 43002
// VideoTypeError 错误码 10090001 视频类型不支持
VideoTypeError ErrCode = 10090001
// ImageTypeError 错误码 10090002 图片类型不支持
ImageTypeError ErrCode = 10090002
// ImageURLError 错误码 10090003 图片 URL 无效
ImageURLError ErrCode = 10090003
// ResourceType 错误码 10090005 resource_type 无效
ResourceType ErrCode = 10090005
// OperationError 错误码 10093011 操作失败
OperationError ErrCode = 10093011
// ParamError2 错误码 10093014 参数错误(包括参数格式、类型等错误)
ParamError2 ErrCode = 10093014
// OperationFrequentError 错误码 10093023 操作过于频繁
OperationFrequentError ErrCode = 10093023
// ResourceNotExistError 错误码 10093030 资源不存在
ResourceNotExistError ErrCode = 10093030
)
const (
// singleFileUpload 单个文件上传,上传媒体(和封面)文件,上传小文件(小于 10MB时使用。上传大文件请使用分片上传接口。
singleFileUpload = "https://api.weixin.qq.com/wxa/sec/vod/singlefileupload?access_token="
// pullUpload 拉取上传,该接口用于将一个网络上的视频拉取上传到平台。
pullUpload = "https://api.weixin.qq.com/wxa/sec/vod/pullupload?access_token="
// getTask 查询任务,该接口用于查询拉取上传的任务状态。
getTask = "https://api.weixin.qq.com/wxa/sec/vod/gettask?access_token="
// applyUpload 申请分片上传
applyUpload = "https://api.weixin.qq.com/wxa/sec/vod/applyupload?access_token="
// uploadPart 上传分片
uploadPart = "https://api.weixin.qq.com/wxa/sec/vod/uploadpart?access_token="
// commitUpload 确认上传,该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性。
commitUpload = "https://api.weixin.qq.com/wxa/sec/vod/commitupload?access_token="
// listMedia 获取媒体列表
listMedia = "https://api.weixin.qq.com/wxa/sec/vod/listmedia?access_token="
// getMedia 获取媒资详细信息,该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
getMedia = "https://api.weixin.qq.com/wxa/sec/vod/getmedia?access_token="
// getMediaLink 获取媒资播放链接,该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
getMediaLink = "https://api.weixin.qq.com/wxa/sec/vod/getmedialink?access_token="
// deleteMedia 删除媒体,该接口用于删除指定媒资。
deleteMedia = "https://api.weixin.qq.com/wxa/sec/vod/deletemedia?access_token="
// auditDrama 审核剧本
auditDrama = "https://api.weixin.qq.com/wxa/sec/vod/auditdrama?access_token="
// listDramas 获取剧目列表
listDramas = "https://api.weixin.qq.com/wxa/sec/vod/listdramas?access_token="
// getDrama 获取剧目信息,该接口用于查询已提交的剧目。
getDrama = "https://api.weixin.qq.com/wxa/sec/vod/getdrama?access_token="
// getCdnUsageData 查询 CDN 用量数据,该接口用于查询点播 CDN 的流量数据。
getCdnUsageData = "https://api.weixin.qq.com/wxa/sec/vod/getcdnusagedata?access_token="
// getCdnLogs 查询 CDN 日志,该接口用于查询点播 CDN 的日志。
getCdnLogs = "https://api.weixin.qq.com/wxa/sec/vod/getcdnlogs?access_token="
)

View File

@@ -0,0 +1,32 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
// Package minidrama Mini Program entertainment mini-drama related interface
package minidrama
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
)
// NewMiniDrama 实例化小程序娱乐直播 API
func NewMiniDrama(ctx *context.Context) *MiniDrama {
return &MiniDrama{
ctx: ctx,
}
}

View File

@@ -0,0 +1,440 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
// MiniDrama mini program entertainment live broadcast related
type MiniDrama struct {
ctx *context.Context
}
// ErrCode error code
type ErrCode int
// SingleFileUploadRequest 单文件上传请求
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>
// <箭头括号> 表示必须替换为有效值的变量。
// 不填写 cover_typecover_data 字段时默认截取视频首帧作为视频封面。
type SingleFileUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaType string `json:"media_type"` // 媒体文件类型 视频格式支持MP4TSMOVMXFMPGFLVWMVAVIM4VF4VMPEG3GPASFMKV示例值"MP4"。
MediaData []byte `json:"media_data"` // 媒体文件数据 视频文件内容,二进制。
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式支持JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF示例值"JPG"。
CoverData []byte `json:"cover_data,omitempty"` // 视频封面图片内容,二进制。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// SingleFileUploadResponse 单文件上传响应
type SingleFileUploadResponse struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// PullUploadRequest 拉取上传请求
// 不填写 cover_url 字段时默认截取视频首帧作为封面。
// Content-Type 需要指定为 application/json
// 该接口为异步接口,上传完成会推送上传完成事件到开发者服务器,开发者也可以调用"查询任务"接口来轮询上传结果。
type PullUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaURL string `json:"media_url"` // 视频 URL示例值"https://developers.weixin.qq.com/test.mp4"。
CoverURL string `json:"cover_url,omitempty"` // 视频封面 URL示例值"https://developers.weixin.qq.com/test.jpg"。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// PullUploadResponse 拉取上传响应
type PullUploadResponse struct {
util.CommonError
TaskID int64 `json:"task_id"` // 任务 ID用于查询拉取上传任务的结果。
}
// GetTaskRequest 查询任务请求
// 该接口用于查询拉取上传的任务状态。
// Content-Type 需要指定为 application/json。
type GetTaskRequest struct {
TaskID int64 `json:"task_id"` // 任务 ID用于查询拉取上传任务的结果。
}
// GetTaskResponse 查询任务响应
type GetTaskResponse struct {
util.CommonError
TaskInfo TaskInfo `json:"task_info"` // 任务信息。
}
// TaskInfo 任务信息
type TaskInfo struct {
ID int64 `json:"id"` // 任务 ID。
TaskType int `json:"task_type"` // 任务类型1拉取上传任务。
Status int `json:"status"` // 任务状态枚举值1. 等待中2. 正在处理3. 已完成4. 失败。
ErrCode int `json:"errcode"` // 任务错误码0 表示成功,其它表示失败。
ErrMsg string `json:"errmsg"` // 任务错误原因。
CreateTime int64 `json:"create_time"` // 任务创建时间,时间戳,单位:秒。
FinishTime int64 `json:"finish_time"` // 任务完成时间,时间戳,单位:秒。
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// ApplyUploadRequest 申请上传请求
// 上传大文件时需使用分片上传方式,分为 3 个步骤:
//
// 申请分片上传,确定文件名、格式类型,返回 upload_id唯一标识本次分片上传。
// 上传分片,多次调用上传文件分片,需要携带 part_number 和 upload_id其中 part_number 为分片的编号,支持乱序上传。当传入 part_number 和 upload_id 都相同的时候,后发起上传请求的分片将覆盖之前的分片。
// 确认分片上传,当上传完所有分片后,需要完成整个文件的合并。请求体中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性最后返回文件的 media_id。
// 如果填写了 cover_type表明本次分片上传除上传媒体文件外还需要上传封面图片不填写 cover_type 则默认截取视频首帧作为封面。
// Content-Type 需要指定为 application/json。
type ApplyUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaType string `json:"media_type"` // 媒体文件类型 视频格式支持MP4TSMOVMXFMPGFLVWMVAVIM4VF4VMPEG3GPASFMKV示例值"MP4"。
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式支持JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF示例值"JPG"。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// ApplyUploadResponse 申请上传响应
type ApplyUploadResponse struct {
util.CommonError
UploadID string `json:"upload_id"` // 本次分片上传的唯一标识。
}
// UploadPartRequest 上传分片请求
// 将文件的其中一个分片上传到平台,最多支持 100 个分片,每个分片大小为 5MB最后一个分片可以小于 5MB。该接口适用于视频和封面图片。视频最大支持 500MB封面图片最大支持 10MB。
// 调用该接口之前必须先调用申请分片上传接口。
// 在申请分片上传时,如果不填写 cover_type则默认截取视频首帧作为封面。
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter><箭头括号>表示必须替换为有效值的变量。
// part_number 从 1 开始。如除了上传视频外还需要上传封面图片,则封面图片的 part_number 需重新从 1 开始编号。
type UploadPartRequest struct {
UploadID string `json:"upload_id"` // 一次分片上传的唯一标识,由申请分片上传接口返回。
PartNumber int `json:"part_number"` // 本次上传的分片的编号,范围在 1 - 100。
ResourceType int `json:"resource_type"` // 指定该分片属于视频还是封面图片的枚举值1. 视频2. 封面图片。
Data []byte `json:"data"` // 分片内容,二进制。
}
// UploadPartResponse 上传分片响应
type UploadPartResponse struct {
util.CommonError
ETag string `json:"etag"` // 上传分片成功后返回的分片标识,用于后续确认分片上传接口。
}
// CommitUploadRequest 确认分片上传请求
// 该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性。
// 注意事项
// Content-Type 需要指定为 application/json。
// 调用该接口之前必须先调用申请分片上传接口以及上传分片接口。
// 如本次分片上传除上传媒体文件外还需要上传封面图片,则请求中还需提供 cover_part_infos 字段以用于合并封面图片文件分片。
// 请求中 media_part_infos 和 cover_part_infos 字段必须按 part_number 从小到大排序part_number 必须从 1 开始,连续且不重复。
type CommitUploadRequest struct {
UploadID string `json:"upload_id"`
MediaPartInfos []*PartInfo `json:"media_part_infos"`
CoverPartInfos []*PartInfo `json:"cover_part_infos,omitempty"`
}
// PartInfo 分片信息
type PartInfo struct {
PartNumber int `json:"part_number"` // 分片编号。
Etag string `json:"etag"` // 使用上传分片接口上传成功后返回的 etag 的值
}
// CommitUploadResponse 确认分片上传响应
type CommitUploadResponse struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// ListMediaRequest 查询媒体列表请求
// 该接口用于查询已经上传到平台的媒体文件列表。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
// media_name 参数支持模糊匹配,当需要模糊匹配时可以在前面或后面加上 %,否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。
// 调用方式
type ListMediaRequest struct {
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID可通过查询剧目列表接口获取。
MediaName string `json:"media_name,omitempty"` // 媒体文件名称,可通过查询媒体列表接口获取,模糊匹配。
StartTime int64 `json:"start_time,omitempty"` // 媒资上传时间>=start_timeUnix 时间戳,单位:秒。
EndTime int64 `json:"end_time,omitempty"` // 媒资上传时间<end_timeUnix 时间戳,单位:秒。
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// MediaInfo 媒体信息
type MediaInfo struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
CreateTime int64 `json:"create_time"` // 上传时间,时间戳。
ExpireTime int64 `json:"expire_time"` // 过期时间,时间戳。
DramaID int64 `json:"drama_id"` // 所属剧目 id。
FileSize string `json:"file_size"` // 媒资文件大小,单位:字节。
Duration int64 `json:"duration"` // 播放时长,单位:秒。
Name string `json:"name"` // 媒资文件名。
Description string `json:"description"` // 描述。
CoverURL string `json:"cover_url"` // 封面图临时链接。
OriginalURL string `json:"original_url"` // 原始视频临时链接。
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
HlsURL string `json:"hls_url"` // hls 格式临时链接。
AuditDetail *MediaAuditDetail `json:"audit_detail"` // 审核信息。
}
// MediaAuditDetail 媒体审核详情
type MediaAuditDetail struct {
Status int `json:"status"` // 审核状态 0 为无效值1 为审核中2 为审核驳回3 为审核通过4 为驳回重填。需要注意可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,而能不能获取播放链接取决于剧目的审核状态。
CreateTime int `json:"create_time"` // 提审时间戳。
AuditTime int `json:"audit_time"` // 审核时间戳。
Reason string `json:"reason"` // 审核备注。该值可能为空。
EvidenceMaterialIDList []string `json:"evidence_material_id_list"` // 审核证据截图 id 列表,截图 id 可以用作 get_material 接口的参数来获得截图内容。
}
// ListMediaResponse 查询媒体列表响应
type ListMediaResponse struct {
util.CommonError
MediaInfoList []*MediaInfo `json:"media_info_list"` // 媒体信息列表。
}
// GetMediaRequest 获取媒体请求
// 该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
type GetMediaRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
}
// GetMediaResponse 获取媒体响应
type GetMediaResponse struct {
util.CommonError
MediaInfo MediaInfo `json:"media_info"` // 媒体信息。
}
// GetMediaLinkRequest 获取媒体链接请求
// 该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
// 能不能获取播放链接取决于剧目审核状态,可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,这种情况也没法获取播放链接。
// 开发者如需区分不同渠道的播放流量或次数,可以在 us 参数中传入渠道标识,这样得到的播放链接中 us 参数的前半部分就包含有渠道标识。开发者把这个带有渠道标识的链接分发给对应的渠道播放,就能统计到不同渠道播放情况。统计的数据来源为 CDN 日志(从 getcdnlogs 接口得到CDN 日志中“文件路径”列中的参数也带有该标识,再结合日志中“字节数”列的流量数值,估算每个渠道所消耗的流量。另需注意日志统计的流量和扣费流量的差异,详情参考 getcdnlogs 接口中的注意事项。
type GetMediaLinkRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
T int64 `json:"t"` // 播放地址的过期时间戳。有效的时间最长不能超过 2 小时后。
US string `json:"us,omitempty"` // 链接标识。平台默认会生成一个仅包含小写字母和数字的字符串用于增强链接的唯一性 (如 us=647488c4792c15185b8fd2a6)。如开发者需要增加自己的标识,比如区分播放的渠道,可使用该参数,该参数最终的值是"开发者标识 - 平台标识"(如开发者传入 abcd则最终的临时链接中 us=abcd-647488c4792c15185b8fd2a6
Expr int `json:"expr,omitempty"` // 试看时长,单位:秒,最大值不能超过视频长度
RLimit int `json:"rlimit,omitempty"` // 最多允许多少个不同 IP 的终端播放,以十进制表示,最大值为 9不填表示不做限制。当限制 URL 只能被 1 个人播放时,建议 rlimit 不要严格限制成 1例如可设置为 3因为移动端断网后重连 IP 可能改变。
WHref string `json:"whref,omitempty"` // 允许访问的域名列表,支持 1 条 - 10 条用半角逗号分隔。域名前不要带协议名http://和 https://),域名为前缀匹配(如填写 abc.com则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com
BkRef string `json:"bkref,omitempty"` // 禁止访问的域名列表,支持 1 条 - 10 条用半角逗号分隔。域名前不要带协议名http://和 https://),域名为前缀匹配(如填写 abc.com则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com
}
// GetMediaLinkResponse 获取媒体链接响应
type GetMediaLinkResponse struct {
util.CommonError
MediaInfo MediaPlaybackInfo `json:"media_info"` // 媒体播放信息。
}
// MediaPlaybackInfo 媒体播放信息
type MediaPlaybackInfo struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
Duration int64 `json:"duration"` // 播放时长,单位:秒。
Name string `json:"name"` // 媒资文件名。
Description string `json:"description"` // 描述。
CoverURL string `json:"cover_url"` // 封面图临时链接。
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
HlsURL string `json:"hls_url"` // hls 格式临时链接。
}
// DeleteMediaRequest 删除媒体请求
// 该接口用于删除已上传到平台的指定媒资文件,用于开发者后台管理使用。
// Content-Type 需要指定为 application/json。
type DeleteMediaRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
}
// DeleteMediaResponse 删除媒体响应
type DeleteMediaResponse struct {
util.CommonError
}
// AuditDramaRequest 审核剧目请求
// 该接口用于审核剧目,审核通过后,剧目下所有剧集都会被审核通过。
// 注意事项
// Content-Type 需要指定为 application/json。
// 剧目信息与审核材料在首次提审时为必填,重新提审时根据是否需要修改选填,
// 本接口中使用的临时图片 material_id 可通过新增临时素材接口上传得到,对应临时素材接口中的 media_id本文档中为避免与剧集的 media_id 混淆,称其为 material_id。
// 新增临时素材接口可以被小程序调用,调用的小程序账号和剧目提审的小程序账号必须是同一个,否则提交审核时会无法识别素材 id。
type AuditDramaRequest struct {
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID可通过查询剧目列表接口获取。首次提审不需要填该参数重新提审时必填
Name string `json:"name,omitempty"` // 剧名,首次提审时必填,重新提审时根据是否需要修改选填。
MediaCount int `json:"media_count,omitempty"` // 剧集数目。首次提审时必填,重新提审时可不填,如要填写也要和第一次提审时一样。
MediaIDList []int64 `json:"media_id_list,omitempty"` // 剧集媒资 media_id 列表。首次提审时必填,而且元素个数必须与 media_count 一致。重新提审时为可选,如果剧集有内容有变化,可以通过新的列表替换未通过的剧集(推荐使用 replace_media_list 进行替换,避免顺序和原列表不一致)。
Producer string `json:"producer,omitempty"` // 制作方。首次提审时必填,重新提审时根据是否需要修改选填。
Description string `json:"description,omitempty"` // 剧描述。首次提审时必填,重新提审时根据是否需要修改选填。
CoverMaterialID string `json:"cover_material_id,omitempty"` // 封面图片临时 media_id。首次提审时必填重新提审时根据是否需要修改选填。
RegistrationNumber string `json:"registration_number,omitempty"` // 剧目备案号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
AuthorizedMaterialID string `json:"authorized_material_id,omitempty"` // 剧目播放授权材料 material_id。如果小程序主体名称和制作方完全一致则不需要填否则必填
PublishLicense string `json:"publish_license,omitempty"` // 网络剧片发行许可证编号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
PublishLicenseMaterialID string `json:"publish_license_material_id,omitempty"` // 网络剧片发行许可证图片,首次提审时如果网络剧片发行许可证编号非空,则该改字段也非空。重新提审时根据是否变化选填
Expedited int `json:"expedited,omitempty"` // 是否加急审核,填 1 表示审核加急0 或不填为不加急。每天有 5 次加急机会。该字段在首次提审时才有效,重新提审时会沿用首次提审时的属性,重新提审不会扣次数。最终是否为加急单,可以根据 DramaInfo.expedited 属性判断
ReplaceMediaList []*ReplaceInfo `json:"replace_media_list,omitempty"` // 重新提审时,如果剧目内容有变化,可以通过该字段替换未通过的剧集。用于重新提审时替换审核不通过的剧集。
}
// ReplaceInfo 替换信息
type ReplaceInfo struct {
Old int64 `json:"old"` // 旧的 media_id
New int64 `json:"new"` // 新的 media_id
}
// AuditDramaResponse 审核剧目响应
type AuditDramaResponse struct {
util.CommonError
DramaID int64 `json:"drama_id"` // 剧目 ID。
}
// ListDramasRequest 查询剧目列表请求
// 该接口用于获取已提交的剧目列表。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
type ListDramasRequest struct {
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// DramaInfo 剧目信息
type DramaInfo struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
CreateTime int64 `json:"create_time"` // 创建时间,时间戳。
Name string `json:"name"` // 剧名。
Playwright string `json:"playwright"` // 编剧。
Producer string `json:"producer"` // 制作方。
ProductionLicense string `json:"production_license"` // 广播电视节目制作经营许可证。
CoverURL string `json:"cover_url"` // 封面图临时链接,根据提审时提交的 cover_material_id 转存得到。
MediaCount int `json:"media_count"` // 剧集数目。
Description string `json:"description"` // 剧描述。
MediaList []*DramaMediaInfo `json:"media_list"` // 剧集信息列表。
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
Expedited int `json:"expedited"` // 是否加急审核1 表示审核加急0 或空为非加急审核。
}
// DramaMediaInfo 剧目媒体信息
type DramaMediaInfo struct {
MediaID int64 `json:"media_id"`
}
// DramaAuditDetail 剧目审核详情
type DramaAuditDetail struct {
Status int `json:"status"` // 审核状态 0 为无效值1 为审核中2 为审核驳回3 为审核通过4 为驳回重填。
CreateTime int64 `json:"create_time"` // 提审时间戳。
AuditTime int64 `json:"audit_time"` // 审核时间戳。
}
// ListDramasResponse 查询剧目列表响应
type ListDramasResponse struct {
util.CommonError
DramaInfoList []*DramaInfo `json:"drama_info_list"` // 剧目信息列表。
}
// GetDramaRequest 获取剧目请求
// 该接口用于查询已提交的剧目。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
type GetDramaRequest struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
}
// GetDramaResponse 获取剧目响应
type GetDramaResponse struct {
util.CommonError
DramaInfo *DramaInfo `json:"drama_info"` // 剧目信息。
}
// GetCdnUsageDataRequest 获取 CDN 用量数据请求
// 该接口用于查询点播 CDN 的流量数据。
// 注意事项
// 可以查询最近 365 天内的 CDN 用量数据。
// 查询时间跨度不超过 90 天。
// 可以指定用量数据的时间粒度,支持 5 分钟、1 小时、1 天的时间粒度。
// 流量为查询时间粒度内的总流量。
type GetCdnUsageDataRequest struct {
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
DataInterval int `json:"data_interval"` // 用量数据的时间粒度单位分钟取值有5:5 分钟粒度,返回指定查询时间内 5 分钟粒度的明细数据。60小时粒度返回指定查询时间内 1 小时粒度的数据。1440天粒度返回指定查询时间内 1 天粒度的数据。默认值为 1440返回天粒度的数据。
}
// DataItem 数据项
type DataItem struct {
Time int64 `json:"time"` // 时间戳,单位:秒。
Value int64 `json:"value"` // 用量数值。
}
// GetCdnUsageDataResponse 获取 CDN 用量数据响应
type GetCdnUsageDataResponse struct {
util.CommonError
DataInterval int `json:"data_interval"`
ItemList []*DataItem `json:"item_list"`
}
// GetCdnLogsRequest 获取 CDN 日志下载链接请求
// 该接口用于获取点播 CDN 日志下载链接。
// 注意事项
// 可以查询最近 30 天内的 CDN 日志下载链接。
// 默认情况下 CDN 每小时生成一个日志文件,如果某一个小时没有 CDN 访问,不会生成日志文件。
// CDN 日志下载链接的有效期为 24 小时。
// 日志字段依次为:请求时间、客户端 IP、访问域名、文件路径、字节数、省级编码、运营商编码、HTTP 状态码、referer、Request-Time、UA、range、HTTP Method、协议标识、缓存 HIT / MISS日志数据打包存在延迟正常情况下 3 小时后数据包趋于完整日志中的字节数为应用层数据大小,未考虑网络协议包头、加速重传等开销,因此与计费数据存在一定差异。
// CDN 日志中记录的下行字节数统计而来的流量数据,是应用层数据。在实际网络传输中,产生的网络流量要比纯应用层流量多 5%-15%,比如 TCP/IP 协议的包头消耗、网络丢包重传等,这些无法被应用层统计到。在业内标准中,计费用流量一般在应用层流量的基础上加上上述开销,媒资管理服务中计费的加速流量约为日志计算加速流量的 110%。
// 省份映射
// 22北京86内蒙古146山西1069河北1177天津119宁夏152陕西1208甘肃1467青海1468新疆145黑龙江1445吉林1464辽宁2福建120江苏121安徽122山东1050上海1442浙江182河南1135湖北1465江西1466湖南118贵州153云南1051重庆1068四川1155西藏4广东173广西1441海南0其他1港澳台-1海外。
// 运营商映射
// 2中国电信26中国联通38教育网43长城宽带1046中国移动3947中国铁通-1海外运营商0其他运营商。
type GetCdnLogsRequest struct {
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// CdnLogInfo CDN 日志信息
type CdnLogInfo struct {
Date int64 `json:"date"` // 日志日期,格式为 YYYYMMDD。
Name string `json:"name"` // 日志文件名
URL string `json:"url"` // 日志下载链接24 小时内下载有效。
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
}
// GetCdnLogsResponse 获取 CDN 日志下载链接响应
type GetCdnLogsResponse struct {
util.CommonError
TotalCount int `json:"total_count"` // 日志总条数。
DomesticCdnLogs []*CdnLogInfo `json:"domestic_cdn_logs"` // 日志信息列表,国内 CDN 节点的日志下载列表。
}
// AsyncMediaUploadEvent 异步媒体上传事件
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-1-%E5%AA%92%E8%B5%84%E4%B8%8A%E4%BC%A0%E5%AE%8C%E6%88%90%E4%BA%8B%E4%BB%B6
type AsyncMediaUploadEvent struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒资文件 id。
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
}
// AsyncMediaAuditEvent 异步媒体审核事件
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-2-%E5%AE%A1%E6%A0%B8%E7%8A%B6%E6%80%81%E4%BA%8B%E4%BB%B6
type AsyncMediaAuditEvent struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
}

View File

@@ -0,0 +1,346 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
import (
"context"
"strconv"
"github.com/silenceper/wechat/v2/util"
)
// SingleFileUpload 单文件上传
func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRequest) (out *SingleFileUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, singleFileUpload); err != nil {
return
}
var (
fields = []util.MultipartFormField{
{
IsFile: true,
Fieldname: "media_data",
Filename: string(in.MediaData),
}, {
IsFile: false,
Fieldname: "media_name",
Value: []byte(in.MediaName),
}, {
IsFile: false,
Fieldname: "media_type",
Value: []byte(in.MediaType),
},
}
response []byte
)
if in.CoverType != "" && in.CoverData != nil {
fields = append(fields, util.MultipartFormField{
IsFile: false,
Fieldname: "cover_type",
Value: []byte(in.CoverType),
})
fields = append(fields, util.MultipartFormField{
IsFile: true,
Fieldname: "cover_data",
Filename: string(in.CoverData),
})
}
if in.SourceContext != "" {
fields = append(fields, util.MultipartFormField{
IsFile: false,
Fieldname: "source_context",
Value: []byte(in.SourceContext),
})
}
if response, err = util.PostMultipartForm(fields, address); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "SingleFileUpload")
return
}
// PullUpload 拉取上传
func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out *PullUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, pullUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "PullUpload")
return
}
// GetTask 查询任务状态
func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out *GetTaskResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getTask); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetTask")
return
}
// ApplyUpload 申请分片上传
func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (out *ApplyUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, applyUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ApplyUpload")
return
}
// UploadPart 上传分片
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter><箭头括号>表示必须替换为有效值的变量。
func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out *UploadPartResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, uploadPart); err != nil {
return
}
var (
fields = []util.MultipartFormField{
{
IsFile: true,
Fieldname: "data",
Filename: string(in.Data),
}, {
IsFile: false,
Fieldname: "upload_id",
Value: []byte(in.UploadID),
}, {
IsFile: false,
Fieldname: "part_number",
Value: []byte(strconv.Itoa(in.PartNumber)),
}, {
IsFile: false,
Fieldname: "resource_type",
Value: []byte(strconv.Itoa(in.PartNumber)),
},
}
response []byte
)
if response, err = util.PostMultipartForm(fields, address); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "UploadPart")
return
}
// CommitUpload 确认上传
func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (out *CommitUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, commitUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "CommitUpload")
return
}
// ListMedia 获取媒体列表
func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out *ListMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ListMedia")
return
}
// GetMedia 获取媒资详细信息
func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out *GetMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetMedia")
return
}
// GetMediaLink 获取媒资播放链接
func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (out *GetMediaLinkResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMediaLink); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetMediaLink")
return
}
// DeleteMedia 删除媒体
func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (out *DeleteMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, deleteMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "DeleteMedia")
return
}
// AuditDrama 审核剧本
func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out *AuditDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, auditDrama); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "AuditDrama")
return
}
// ListDramas 获取剧目列表
func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out *ListDramasResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listDramas); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ListDramas")
return
}
// GetDrama 获取剧目信息
func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out *GetDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getDrama); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetDrama")
return
}
// GetCdnUsageData 查询 CDN 用量数据
func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequest) (out *GetCdnUsageDataResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnUsageData); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetCdnUsageData")
return
}
// GetCdnLogs 查询 CDN 日志
func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out *GetCdnLogsResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnLogs); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetCdnLogs")
return
}
// requestAddress 请求地址
func (s *MiniDrama) requestAddress(_ context.Context, url string) (string, error) {
accessToken, err := s.ctx.GetAccessToken()
if err != nil {
return "", err
}
return url + accessToken, nil
}

View File

@@ -11,6 +11,8 @@ import (
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/encryptor"
"github.com/silenceper/wechat/v2/miniprogram/message"
"github.com/silenceper/wechat/v2/miniprogram/minidrama"
"github.com/silenceper/wechat/v2/miniprogram/order"
"github.com/silenceper/wechat/v2/miniprogram/privacy"
"github.com/silenceper/wechat/v2/miniprogram/qrcode"
"github.com/silenceper/wechat/v2/miniprogram/riskcontrol"
@@ -138,3 +140,18 @@ func (miniProgram *MiniProgram) GetOpenAPI() *openapi.OpenAPI {
func (miniProgram *MiniProgram) GetVirtualPayment() *virtualpayment.VirtualPayment {
return virtualpayment.NewVirtualPayment(miniProgram.ctx)
}
// GetMessageReceiver 获取消息推送接收器
func (miniProgram *MiniProgram) GetMessageReceiver() *message.PushReceiver {
return message.NewPushReceiver(miniProgram.ctx)
}
// GetShipping 小程序发货信息管理服务
func (miniProgram *MiniProgram) GetShipping() *order.Shipping {
return order.NewShipping(miniProgram.ctx)
}
// GetMiniDrama 小程序娱乐微短剧
func (miniProgram *MiniProgram) GetMiniDrama() *minidrama.MiniDrama {
return minidrama.NewMiniDrama(miniProgram.ctx)
}

View File

@@ -0,0 +1,269 @@
package order
import (
"fmt"
"time"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// 发货信息录入
uploadShippingInfoURL = "https://api.weixin.qq.com/wxa/sec/order/upload_shipping_info?access_token=%s"
// 查询订单发货状态
getShippingOrderURL = "https://api.weixin.qq.com/wxa/sec/order/get_order?access_token=%s"
// 查询订单列表
getShippingOrderListURL = "https://api.weixin.qq.com/wxa/sec/order/get_order_list?access_token=%s"
// 确认收货提醒接口
notifyConfirmReceiveURL = "https://api.weixin.qq.com/wxa/sec/order/notify_confirm_receive?access_token=%s"
)
// Shipping 发货信息管理
type Shipping struct {
*context.Context
}
// NewShipping init
func NewShipping(ctx *context.Context) *Shipping {
return &Shipping{ctx}
}
// UploadShippingInfo 发货信息录入
// see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/order-shipping/order-shipping.html
func (shipping *Shipping) UploadShippingInfo(in *UploadShippingInfoRequest) (err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(uploadShippingInfoURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
return util.DecodeWithCommonError(response, "UploadShippingInfo")
}
// GetShippingOrder 查询订单发货状态
func (shipping *Shipping) GetShippingOrder(in *GetShippingOrderRequest) (res ShippingOrderResponse, err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getShippingOrderURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetShippingOrder")
return
}
// GetShippingOrderList 查询订单列表
func (shipping *Shipping) GetShippingOrderList(in *GetShippingOrderListRequest) (res GetShippingOrderListResponse, err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getShippingOrderListURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetShippingOrderList")
return
}
// NotifyConfirmReceive 确认收货提醒接口
func (shipping *Shipping) NotifyConfirmReceive(in *NotifyConfirmReceiveRequest) (err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(notifyConfirmReceiveURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
return util.DecodeWithCommonError(response, "NotifyConfirmReceive")
}
// UploadShippingInfoRequest 发货信息录入请求参数
type UploadShippingInfoRequest struct {
OrderKey *ShippingOrderKey `json:"order_key"` // 订单,需要上传物流信息的订单
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
IsAllDelivered bool `json:"is_all_delivered"` // 分拆发货模式时必填,用于标识分拆发货模式下是否已全部发货完成
ShippingList []*ShippingInfo `json:"shipping_list"` // 物流信息列表,发货物流单列表,支持统一发货(单个物流单)和分拆发货(多个物流单)两种模式
UploadTime *time.Time `json:"upload_time"` // 上传时间,用于标识请求的先后顺序
Payer *ShippingPayer `json:"payer"` // 支付人信息
}
// ShippingOrderKey 订单
type ShippingOrderKey struct {
OrderNumberType NumberType `json:"order_number_type"` // 订单单号类型用于确认需要上传详情的订单。枚举值1使用下单商户号和商户侧单号枚举值2使用微信支付单号。
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
Mchid string `json:"mchid"` // 支付下单商户的商户号,由微信支付生成并下发
OutTradeNo string `json:"out_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
}
// ShippingPayer 支付者信息
type ShippingPayer struct {
Openid string `json:"openid"` // 用户标识用户在小程序appid下的唯一标识
}
// ShippingInfo 物流信息
type ShippingInfo struct {
TrackingNo string `json:"tracking_no"` // 物流单号,物流快递发货时必填
ExpressCompany string `json:"express_company"` // 物流公司编码快递公司ID物流快递发货时必填参见「查询物流公司编码列表」
ItemDesc string `json:"item_desc"` // 商品信息,例如:微信红包抱枕*1个限120个字以内
Contact ShippingContact `json:"contact"` // 联系方式,当发货的物流公司为顺丰时,联系方式为必填,收件人或寄件人联系方式二选一
}
// ShippingContact 联系方式
type ShippingContact struct {
ConsignorContact string `json:"consignor_contact"` // 寄件人联系方式寄件人联系方式采用掩码传输最后4位数字不能打掩码
ReceiverContact string `json:"receiver_contact"` // 收件人联系方式收件人联系方式采用掩码传输最后4位数字不能打掩码
}
// DeliveryMode 发货模式
type DeliveryMode uint8
const (
// DeliveryModeUnifiedDelivery 统一发货
DeliveryModeUnifiedDelivery DeliveryMode = 1
// DeliveryModeSplitDelivery 分拆发货
DeliveryModeSplitDelivery DeliveryMode = 2
)
// LogisticsType 物流模式
type LogisticsType uint8
const (
// LogisticsTypeExpress 实体物流配送采用快递公司进行实体物流配送形式
LogisticsTypeExpress LogisticsType = 1
// LogisticsTypeSameCity 同城配送
LogisticsTypeSameCity LogisticsType = 2
// LogisticsTypeVirtual 虚拟商品,虚拟商品,例如话费充值,点卡等,无实体配送形式
LogisticsTypeVirtual LogisticsType = 3
// LogisticsTypeSelfPickup 用户自提
LogisticsTypeSelfPickup LogisticsType = 4
)
// NumberType 订单单号类型
type NumberType uint8
const (
// NumberTypeOutTradeNo 使用下单商户号和商户侧单号
NumberTypeOutTradeNo NumberType = 1
// NumberTypeTransactionID 使用微信支付单号
NumberTypeTransactionID NumberType = 2
)
// GetShippingOrderRequest 查询订单发货状态参数
type GetShippingOrderRequest struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` //二级商户号
MerchantTradeNo string `json:"merchant_trade_no"` //商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一。
}
// ShippingItem 物流信息
type ShippingItem struct {
TrackingNo string `json:"tracking_no"` // 物流单号,示例值: "323244567777
ExpressCompany string `json:"express_company"` // 物流公司编码快递公司ID物流快递发货时必填参见「查询物流公司编码列表」
UploadTime int64 `json:"upload_time"` // 上传物流信息时间,时间戳形式
}
// ShippingDetail 发货信息
type ShippingDetail struct {
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
FinishShipping bool `json:"finish_shipping"` // 是否已全部发货
FinishShippingCount int `json:"finish_shipping_count"` // 已完成全部发货的次数
GoodsDesc string `json:"goods_desc"` // 在小程序后台发货信息录入页录入的商品描述
ShippingList []*ShippingItem `json:"shipping_list"` // 物流信息列表
}
// ShippingOrder 订单发货状态
type ShippingOrder struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
Description string `json:"description"` // 以分号连接的该支付单的所有商品描述当超过120字时自动截断并以 “...” 结尾
PaidAmount int64 `json:"paid_amount"` // 支付单实际支付金额,整型,单位:分钱
Openid string `json:"openid"` // 支付者openid
TradeCreateTime int64 `json:"trade_create_time"` // 交易创建时间,时间戳形式
PayTime int64 `json:"pay_time"` // 支付时间,时间戳形式
InComplaint bool `json:"in_complaint"` // 是否处在交易纠纷中
OrderState State `json:"order_state"` // 订单状态枚举:(1) 待发货;(2) 已发货;(3) 确认收货;(4) 交易完成;(5) 已退款
Shipping *ShippingDetail `json:"shipping"` // 订单发货信息
}
// ShippingOrderResponse 查询订单发货状态返回参数
type ShippingOrderResponse struct {
util.CommonError
Order ShippingOrder `json:"order"` // 订单发货信息
}
// State 订单状态
type State uint8
const (
// StateWaitShipment 待发货
StateWaitShipment State = 1
// StateShipped 已发货
StateShipped State = 2
// StateConfirm 确认收货
StateConfirm State = 3
// StateComplete 交易完成
StateComplete State = 4
// StateRefund 已退款
StateRefund State = 5
)
// GetShippingOrderListRequest 查询订单列表请求参数
type GetShippingOrderListRequest struct {
PayTimeRange *TimeRange `json:"pay_time_range"` // 支付时间范围
OrderState State `json:"order_state,omitempty"` // 订单状态
Openid string `json:"openid,omitempty"` // 支付者openid
LastIndex string `json:"last_index,omitempty"` // 翻页时使用,获取第一页时不用传入,如果查询结果中 has_more 字段为 true则传入该次查询结果中返回的 last_index 字段可获取下一页
PageSize int64 `json:"page_size"` // 每页数量最多50条
}
// TimeRange 时间范围
type TimeRange struct {
BeginTime int64 `json:"begin_time,omitempty"` // 查询开始时间,时间戳形式
EndTime int64 `json:"end_time,omitempty"` // 查询结束时间,时间戳形式
}
// GetShippingOrderListResponse 查询订单列表返回参数
type GetShippingOrderListResponse struct {
util.CommonError
OrderList []*ShippingOrder `json:"order_list"`
LastIndex string `json:"last_index"`
HasMore bool `json:"has_more"`
}
// NotifyConfirmReceiveRequest 确认收货提醒接口请求参数
type NotifyConfirmReceiveRequest struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
ReceivedTime int64 `json:"received_time"` // 收货时间,时间戳形式
}

View File

@@ -117,6 +117,24 @@ const (
// queryPublishGoods 查询批量发布道具任务状态
queryPublishGoods = "/xpay/query_publish_goods"
// queryBizBalance 查询商家账户里的可提现余额
queryBizBalance = "/xpay/query_biz_balance"
// queryTransferAccount 查询广告金充值账户
queryTransferAccount = "/xpay/query_transfer_account"
// queryAdverFunds 查询广告金发放记录
queryAdverFunds = "/xpay/query_adver_funds"
// createFundsBill 充值广告金
createFundsBill = "/xpay/create_funds_bill"
// bindTransferAccount 绑定广告金充值账户
bindTransferAccount = "/xpay/bind_transfer_accout"
// defaultUnifiedOrderURL default unified order url
defaultUnifiedOrderURL = "requestVirtualPayment"
)
const (

View File

@@ -145,6 +145,8 @@ type OrderItem struct {
WxOrderID string `json:"wx_order_id"` // 微信内部单号
ChannelOrderID string `json:"channel_order_id"` // 渠道订单号,为用户微信支付详情页面上的商户单号
WxPayOrderID string `json:"wxpay_order_id"` // 微信支付交易单号,为用户微信支付详情页面上的交易单号
SettTime int64 `json:"sett_time"` // 结算时间unix 秒级时间戳,结算时间的秒级时间戳,大于 0 表示结算成功
SettState uint `json:"sett_state"` // 结算状态 0-未开始结算 1-结算中 2-结算成功
}
// QueryOrderResponse 查询创建的订单(现金单,非代币单)响应参数

View File

@@ -60,10 +60,7 @@ func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBala
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "QueryUserBalance"); err != nil {
return
}
err = util.DecodeWithError(response, out, "QueryUserBalance")
return
}
@@ -91,10 +88,7 @@ func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "CurrencyPay"); err != nil {
return
}
err = util.DecodeWithError(response, out, "CurrencyPay")
return
}
@@ -122,10 +116,7 @@ func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest)
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "QueryOrder"); err != nil {
return
}
err = util.DecodeWithError(response, out, "QueryOrder")
return
}
@@ -153,10 +144,7 @@ func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurren
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "CancelCurrencyPay"); err != nil {
return
}
err = util.DecodeWithError(response, out, "CancelCurrencyPay")
return
}
@@ -186,10 +174,7 @@ func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvi
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "NotifyProvideGoods"); err != nil {
return
}
err = util.DecodeWithError(response, out, "NotifyProvideGoods")
return
}
@@ -218,10 +203,7 @@ func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrenc
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "PresentCurrency"); err != nil {
return
}
err = util.DecodeWithError(response, out, "PresentCurrency")
return
}
@@ -250,10 +232,7 @@ func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillReque
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "DownloadBill"); err != nil {
return
}
err = util.DecodeWithError(response, out, "DownloadBill")
return
}
@@ -282,10 +261,7 @@ func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "RefundOrder"); err != nil {
return
}
err = util.DecodeWithError(response, out, "RefundOrder")
return
}
@@ -314,10 +290,7 @@ func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWith
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "CreateWithdrawOrder"); err != nil {
return
}
err = util.DecodeWithError(response, out, "CreateWithdrawOrder")
return
}
@@ -346,10 +319,7 @@ func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdr
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "QueryWithdrawOrder"); err != nil {
return
}
err = util.DecodeWithError(response, out, "QueryWithdrawOrder")
return
}
@@ -378,10 +348,7 @@ func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGo
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "StartUploadGoods"); err != nil {
return
}
err = util.DecodeWithError(response, out, "StartUploadGoods")
return
}
@@ -410,10 +377,7 @@ func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGo
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "QueryUploadGoods"); err != nil {
return
}
err = util.DecodeWithError(response, out, "QueryUploadGoods")
return
}
@@ -442,10 +406,7 @@ func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublish
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "StartPublishGoods"); err != nil {
return
}
err = util.DecodeWithError(response, out, "StartPublishGoods")
return
}
@@ -474,10 +435,7 @@ func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublish
}
// 使用通用方法返回错误
if err = util.DecodeWithError(response, out, "QueryPublishGoods"); err != nil {
return
}
err = util.DecodeWithError(response, out, "QueryPublishGoods")
return
}
@@ -521,6 +479,7 @@ func (s *VirtualPayment) requestAddress(params URLParams) (url string, err error
case queryUserBalance:
case currencyPay:
case cancelCurrencyPay:
case defaultUnifiedOrderURL:
if params.PaySign, params.Signature, err = s.PaySignature(params.Path, params.Content); err != nil {
return
}

View File

@@ -7,6 +7,8 @@ import (
)
const (
// departmentCreateURL 创建部门
departmentCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=%s"
// departmentSimpleListURL 获取子部门ID列表
departmentSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/simplelist?access_token=%s&id=%d"
// departmentListURL 获取部门列表
@@ -14,6 +16,20 @@ const (
)
type (
// DepartmentCreateRequest 创建部门数据请求
DepartmentCreateRequest struct {
Name string `json:"name"`
NameEn string `json:"name_en,omitempty"`
ParentID int `json:"parentid"`
Order int `json:"order,omitempty"`
ID int `json:"id,omitempty"`
}
// DepartmentCreateResponse 创建部门数据响应
DepartmentCreateResponse struct {
util.CommonError
ID int `json:"id"`
}
// DepartmentSimpleListResponse 获取子部门ID列表响应
DepartmentSimpleListResponse struct {
util.CommonError
@@ -42,6 +58,27 @@ type (
}
)
// DepartmentCreate 创建部门
// see https://developer.work.weixin.qq.com/document/path/90205
func (r *Client) DepartmentCreate(req *DepartmentCreateRequest) (*DepartmentCreateResponse, 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(departmentCreateURL, accessToken), req); err != nil {
return nil, err
}
result := &DepartmentCreateResponse{}
if err = util.DecodeWithError(response, result, "DepartmentCreate"); err != nil {
return nil, err
}
return result, nil
}
// DepartmentSimpleList 获取子部门ID列表
// see https://developer.work.weixin.qq.com/document/path/95350
func (r *Client) DepartmentSimpleList(departmentID int) ([]*DepartmentID, error) {

View File

@@ -1,6 +1,7 @@
package addresslist
import (
"fmt"
"strings"
"github.com/silenceper/wechat/v2/util"
@@ -9,8 +10,12 @@ import (
const (
// userSimpleListURL 获取部门成员
userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist"
// userCreateURL 创建成员
userCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=%s"
// userGetURL 读取成员
userGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get"
// userDeleteURL 删除成员
userDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/user/delete"
// userListIDURL 获取成员ID列表
userListIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/list_id"
// convertToOpenIDURL userID转openID
@@ -62,6 +67,98 @@ func (r *Client) UserSimpleList(departmentID int) ([]*UserList, error) {
return result.UserList, nil
}
type (
// UserCreateRequest 创建成员数据请求
UserCreateRequest struct {
UserID string `json:"userid"`
Name string `json:"name"`
Alias string `json:"alias"`
Mobile string `json:"mobile"`
Department []int `json:"department"`
Order []int `json:"order"`
Position string `json:"position"`
Gender int `json:"gender"`
Email string `json:"email"`
BizMail string `json:"biz_mail"`
IsLeaderInDept []int `json:"is_leader_in_dept"`
DirectLeader []string `json:"direct_leader"`
Enable int `json:"enable"`
AvatarMediaid string `json:"avatar_mediaid"`
Telephone string `json:"telephone"`
Address string `json:"address"`
MainDepartment int `json:"main_department"`
Extattr struct {
Attrs []ExtraAttr `json:"attrs"`
} `json:"extattr"`
ToInvite bool `json:"to_invite"`
ExternalPosition string `json:"external_position"`
ExternalProfile ExternalProfile `json:"external_profile"`
}
// ExtraAttr 扩展属性
ExtraAttr struct {
Type int `json:"type"`
Name string `json:"name"`
Text struct {
Value string `json:"value"`
} `json:"text,omitempty"`
Web struct {
URL string `json:"url"`
Title string `json:"title"`
} `json:"web,omitempty"`
}
// ExternalProfile 成员对外信息
ExternalProfile struct {
ExternalCorpName string `json:"external_corp_name"`
WechatChannels struct {
Nickname string `json:"nickname"`
Status int `json:"status"`
} `json:"wechat_channels"`
ExternalAttr []ExternalProfileAttr `json:"external_attr"`
}
// ExternalProfileAttr 成员对外信息属性
ExternalProfileAttr struct {
Type int `json:"type"`
Name string `json:"name"`
Text struct {
Value string `json:"value"`
} `json:"text,omitempty"`
Web struct {
URL string `json:"url"`
Title string `json:"title"`
} `json:"web,omitempty"`
Miniprogram struct {
Appid string `json:"appid"`
Pagepath string `json:"pagepath"`
Title string `json:"title"`
} `json:"miniprogram,omitempty"`
}
// UserCreateResponse 创建成员数据响应
UserCreateResponse struct {
util.CommonError
}
)
// UserCreate 创建成员
// @see https://developer.work.weixin.qq.com/document/path/90195
func (r *Client) UserCreate(req *UserCreateRequest) (*UserCreateResponse, 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(userCreateURL, accessToken), req); err != nil {
return nil, err
}
result := &UserCreateResponse{}
if err = util.DecodeWithError(response, result, "UserCreate"); err != nil {
return nil, err
}
return result, nil
}
// UserGetResponse 获取部门成员响应
type UserGetResponse struct {
util.CommonError
@@ -154,6 +251,40 @@ func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
return result, nil
}
type (
// UserDeleteResponse 删除成员数据响应
UserDeleteResponse struct {
util.CommonError
}
)
// UserDelete 删除成员
// @see https://developer.work.weixin.qq.com/document/path/90334
func (r *Client) UserDelete(userID string) (*UserDeleteResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(strings.Join([]string{
userDeleteURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
"userid": userID,
}),
}, "?")); err != nil {
return nil, err
}
result := &UserDeleteResponse{}
if err = util.DecodeWithError(response, result, "UserDelete"); err != nil {
return nil, err
}
return result, nil
}
// UserListIDRequest 获取成员ID列表请求
type UserListIDRequest struct {
Cursor string `json:"cursor"`

View File

@@ -0,0 +1,326 @@
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"
)
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{}
if err = util.DecodeWithError(response, result, "ListLink"); err != nil {
return nil, err
}
return result, nil
}
type (
// GetCustomerAcquisitionRequest 获取获客链接详情请求
GetCustomerAcquisitionRequest struct {
LinkID string `json:"link_id"`
}
// GetCustomerAcquisitionResponse 获取获客链接详情响应
GetCustomerAcquisitionResponse struct {
util.CommonError
Link Link `json:"link"`
Range CustomerAcquisitionRange `json:"range"`
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"`
}
// CustomerAcquisitionRange 该获客链接使用范围
CustomerAcquisitionRange struct {
UserList []string `json:"user_list"`
DepartmentList []int64 `json:"department_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{}
if err = util.DecodeWithError(response, result, "GetCustomerAcquisition"); err != nil {
return nil, err
}
return result, nil
}
type (
// CreateCustomerAcquisitionLinkRequest 创建获客链接请求
CreateCustomerAcquisitionLinkRequest struct {
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
}
// 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{}
if err = util.DecodeWithError(response, result, "CreateCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
}
type (
// UpdateCustomerAcquisitionLinkRequest 编辑获客链接请求
UpdateCustomerAcquisitionLinkRequest struct {
LinkID string `json:"link_id"`
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
}
// 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{}
if err = util.DecodeWithError(response, result, "UpdateCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
}
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{}
if err = util.DecodeWithError(response, result, "DeleteCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
}
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{}
if err = util.DecodeWithError(response, result, "GetCustomerInfoWithCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
}
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{}
if err = util.DecodeWithError(response, result, "CustomerAcquisitionQuota"); err != nil {
return nil, err
}
return result, nil
}
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{}
if err = util.DecodeWithError(response, result, "CustomerAcquisitionStatistic"); err != nil {
return nil, err
}
return result, nil
}

View File

@@ -25,6 +25,10 @@ const (
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 创建企业群发请求
@@ -422,3 +426,47 @@ func (r *Client) DelGroupWelcomeTemplate(req *DelGroupWelcomeTemplateRequest) er
}
return nil
}
// 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")
}

359
work/kf/knowledge.go Normal file
View File

@@ -0,0 +1,359 @@
package kf
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// addKnowledgeGroupURL 知识库分组添加
addKnowledgeGroupURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/add_group?access_token=%s"
// delKnowledgeGroupURL 知识库分组删除
delKnowledgeGroupURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/del_group?access_token=%s"
// modKnowledgeGroupURL 知识库分组修改
modKnowledgeGroupURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/mod_group?access_token=%s"
// listKnowledgeGroupURL 知识库分组列表
listKnowledgeGroupURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/list_group?access_token=%s"
// addKnowledgeIntentURL 知识库问答添加
addKnowledgeIntentURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/add_intent?access_token=%s"
// delKnowledgeIntentURL 知识库问答删除
delKnowledgeIntentURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/del_intent?access_token=%s"
// modKnowledgeIntentURL 知识库问答修改
modKnowledgeIntentURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/mod_intent?access_token=%s"
// listKnowledgeIntentURL 知识库问答列表
listKnowledgeIntentURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/knowledge/list_intent?access_token=%s"
)
// AddKnowledgeGroupRequest 知识库分组添加请求
type AddKnowledgeGroupRequest struct {
Name string `json:"name"`
}
// AddKnowledgeGroupResponse 知识库分组添加响应
type AddKnowledgeGroupResponse struct {
util.CommonError
GroupID string `json:"group_id"`
}
// AddKnowledgeGroup 知识库分组添加
// see https://developer.work.weixin.qq.com/document/path/95971#%E6%B7%BB%E5%8A%A0%E5%88%86%E7%BB%84
func (r *Client) AddKnowledgeGroup(req *AddKnowledgeGroupRequest) (*AddKnowledgeGroupResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addKnowledgeGroupURL, accessToken), req); err != nil {
return nil, err
}
result := &AddKnowledgeGroupResponse{}
err = util.DecodeWithError(response, result, "AddKnowledgeGroup")
return result, err
}
// DelKnowledgeGroupRequest 知识库分组删除请求
type DelKnowledgeGroupRequest struct {
GroupID string `json:"group_id"`
}
// DelKnowledgeGroup 知识库分组删除
// see https://developer.work.weixin.qq.com/document/path/95971#%E5%88%A0%E9%99%A4%E5%88%86%E7%BB%84
func (r *Client) DelKnowledgeGroup(req *DelKnowledgeGroupRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(delKnowledgeGroupURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DelKnowledgeGroup")
}
// ModKnowledgeGroupRequest 知识库分组修改请求
type ModKnowledgeGroupRequest struct {
GroupID string `json:"group_id"`
Name string `json:"name"`
}
// ModKnowledgeGroup 知识库分组修改
// see https://developer.work.weixin.qq.com/document/path/95971#%E4%BF%AE%E6%94%B9%E5%88%86%E7%BB%84
func (r *Client) ModKnowledgeGroup(req *ModKnowledgeGroupRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(modKnowledgeGroupURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "ModKnowledgeGroup")
}
// ListKnowledgeGroupRequest 知识库分组列表请求
type ListKnowledgeGroupRequest struct {
Cursor string `json:"cursor"`
Limit int `json:"limit"`
GroupID string `json:"group_id"`
}
// ListKnowledgeGroupResponse 知识库分组列表响应
type ListKnowledgeGroupResponse struct {
util.CommonError
NextCursor string `json:"next_cursor"`
HasMore int `json:"has_more"`
GroupList []KnowledgeGroup `json:"group_list"`
}
// KnowledgeGroup 知识库分组
type KnowledgeGroup struct {
GroupID string `json:"group_id"`
Name string `json:"name"`
IsDefault int `json:"is_default"`
}
// ListKnowledgeGroup 知识库分组列表
// see https://developer.work.weixin.qq.com/document/path/95971#%E8%8E%B7%E5%8F%96%E5%88%86%E7%BB%84%E5%88%97%E8%A1%A8
func (r *Client) ListKnowledgeGroup(req *ListKnowledgeGroupRequest) (*ListKnowledgeGroupResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(listKnowledgeGroupURL, accessToken), req); err != nil {
return nil, err
}
result := &ListKnowledgeGroupResponse{}
err = util.DecodeWithError(response, result, "ListKnowledgeGroup")
return result, err
}
// AddKnowledgeIntentRequest 知识库问答添加请求
type AddKnowledgeIntentRequest struct {
GroupID string `json:"group_id"`
Question IntentQuestion `json:"question"`
SimilarQuestions IntentSimilarQuestions `json:"similar_questions"`
Answers []IntentAnswerReq `json:"answers"`
}
// IntentQuestion 主问题
type IntentQuestion struct {
Text IntentQuestionText `json:"text"`
}
// IntentQuestionText 问题文本
type IntentQuestionText struct {
Content string `json:"content"`
}
// IntentSimilarQuestions 相似问题
type IntentSimilarQuestions struct {
Items []IntentQuestion `json:"items"`
}
// IntentAnswerReq 回答请求
type IntentAnswerReq struct {
Text IntentAnswerText `json:"text"`
Attachments []IntentAnswerAttachmentReq `json:"attachments"`
}
// IntentAnswerText 回答文本
type IntentAnswerText struct {
Content string `json:"content"`
}
// IntentAnswerAttachmentReq 回答附件请求
type IntentAnswerAttachmentReq struct {
MsgType string `json:"msgtype"`
Image IntentAnswerAttachmentImgReq `json:"image,omitempty"`
Video IntentAnswerAttachmentVideoReq `json:"video,omitempty"`
Link IntentAnswerAttachmentLink `json:"link,omitempty"`
MiniProgram IntentAnswerAttachmentMiniProgramReq `json:"miniprogram,omitempty"`
}
// IntentAnswerAttachmentImgReq 图片类型回答附件请求
type IntentAnswerAttachmentImgReq struct {
MediaID string `json:"media_id"`
}
// IntentAnswerAttachmentVideoReq 视频类型回答附件请求
type IntentAnswerAttachmentVideoReq struct {
MediaID string `json:"media_id"`
}
// IntentAnswerAttachmentLink 链接类型回答附件
type IntentAnswerAttachmentLink struct {
Title string `json:"title"`
PicURL string `json:"picurl"`
Desc string `json:"desc"`
URL string `json:"url"`
}
// IntentAnswerAttachmentMiniProgramReq 小程序类型回答附件请求
type IntentAnswerAttachmentMiniProgramReq struct {
Title string `json:"title"`
ThumbMediaID string `json:"thumb_media_id"`
AppID string `json:"appid"`
PagePath string `json:"pagepath"`
}
// AddKnowledgeIntentResponse 知识库问答添加响应
type AddKnowledgeIntentResponse struct {
util.CommonError
IntentID string `json:"intent_id"`
}
// AddKnowledgeIntent 知识库问答添加
// see https://developer.work.weixin.qq.com/document/path/95972#%E6%B7%BB%E5%8A%A0%E9%97%AE%E7%AD%94
func (r *Client) AddKnowledgeIntent(req *AddKnowledgeIntentRequest) (*AddKnowledgeIntentResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addKnowledgeIntentURL, accessToken), req); err != nil {
return nil, err
}
result := &AddKnowledgeIntentResponse{}
err = util.DecodeWithError(response, result, "AddKnowledgeIntent")
return result, err
}
// DelKnowledgeIntentRequest 知识库问答删除请求
type DelKnowledgeIntentRequest struct {
IntentID string `json:"intent_id"`
}
// DelKnowledgeIntent 知识库问答删除
// see https://developer.work.weixin.qq.com/document/path/95972#%E5%88%A0%E9%99%A4%E9%97%AE%E7%AD%94
func (r *Client) DelKnowledgeIntent(req *DelKnowledgeIntentRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(delKnowledgeIntentURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DelKnowledgeIntent")
}
// ModKnowledgeIntentRequest 知识库问答修改请求
type ModKnowledgeIntentRequest struct {
IntentID string `json:"intent_id"`
Question IntentQuestion `json:"question"`
SimilarQuestions IntentSimilarQuestions `json:"similar_questions"`
Answers []IntentAnswerReq `json:"answers"`
}
// ModKnowledgeIntent 知识库问答修改
// see https://developer.work.weixin.qq.com/document/path/95972#%E4%BF%AE%E6%94%B9%E9%97%AE%E7%AD%94
func (r *Client) ModKnowledgeIntent(req *ModKnowledgeIntentRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(modKnowledgeIntentURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "ModKnowledgeIntent")
}
// ListKnowledgeIntentRequest 知识库问答列表请求
type ListKnowledgeIntentRequest struct {
Cursor string `json:"cursor"`
Limit int `json:"limit"`
GroupID string `json:"group_id"`
IntentID string `json:"intent_id"`
}
// ListKnowledgeIntentResponse 知识库问答列表响应
type ListKnowledgeIntentResponse struct {
util.CommonError
NextCursor string `json:"next_cursor"`
HasMore int `json:"has_more"`
IntentList []KnowledgeIntent `json:"intent_list"`
}
// KnowledgeIntent 问答摘要
type KnowledgeIntent struct {
GroupID string `json:"group_id"`
IntentID string `json:"intent_id"`
Question IntentQuestion `json:"question"`
SimilarQuestions IntentSimilarQuestions `json:"similar_questions"`
Answers []IntentAnswerRes `json:"answers"`
}
// IntentAnswerRes 回答返回
type IntentAnswerRes struct {
Text IntentAnswerText `json:"text"`
Attachments []IntentAnswerAttachmentRes `json:"attachments"`
}
// IntentAnswerAttachmentRes 回答附件返回
type IntentAnswerAttachmentRes struct {
MsgType string `json:"msgtype"`
Image IntentAnswerAttachmentImgRes `json:"image,omitempty"`
Video IntentAnswerAttachmentVideoRes `json:"video,omitempty"`
Link IntentAnswerAttachmentLink `json:"link,omitempty"`
MiniProgram IntentAnswerAttachmentMiniProgramRes `json:"miniprogram,omitempty"`
}
// IntentAnswerAttachmentImgRes 图片类型回答附件返回
type IntentAnswerAttachmentImgRes struct {
Name string `json:"name"`
}
// IntentAnswerAttachmentVideoRes 视频类型回答附件返回
type IntentAnswerAttachmentVideoRes struct {
Name string `json:"name"`
}
// IntentAnswerAttachmentMiniProgramRes 小程序类型回答附件返回
type IntentAnswerAttachmentMiniProgramRes struct {
Title string `json:"title"`
AppID string `json:"appid"`
PagePath string `json:"pagepath"`
}
// ListKnowledgeIntent 知识库问答列表
// see https://developer.work.weixin.qq.com/document/path/95972#%E8%8E%B7%E5%8F%96%E9%97%AE%E7%AD%94%E5%88%97%E8%A1%A8
func (r *Client) ListKnowledgeIntent(req *ListKnowledgeIntentRequest) (*ListKnowledgeIntentResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(listKnowledgeIntentURL, accessToken), req); err != nil {
return nil, err
}
result := &ListKnowledgeIntentResponse{}
err = util.DecodeWithError(response, result, "ListKnowledgeIntent")
return result, err
}

127
work/kf/statistic.go Normal file
View File

@@ -0,0 +1,127 @@
package kf
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// getCorpStatisticURL 获取「客户数据统计」企业汇总数据
getCorpStatisticURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/get_corp_statistic?access_token=%s"
// getServicerStatisticURL 获取「客户数据统计」接待人员明细数据
getServicerStatisticURL = "https://qyapi.weixin.qq.com/cgi-bin/kf/get_servicer_statistic?access_token=%s"
)
// GetCorpStatisticRequest 获取「客户数据统计」企业汇总数据请求
type GetCorpStatisticRequest struct {
OpenKfID string `json:"open_kfid"`
StartTime int64 `json:"start_time"`
EndTime int64 `json:"end_time"`
}
// GetCorpStatisticResponse 获取「客户数据统计」企业汇总数据响应
type GetCorpStatisticResponse struct {
util.CommonError
StatisticList []CorpStatisticList `json:"statistic_list"`
}
// CorpStatisticList 企业汇总统计数据列表
type CorpStatisticList struct {
StatTime int64 `json:"stat_time"`
Statistic CorpStatistic `json:"statistic"`
}
// CorpStatistic 企业汇总统计一天的统计数据
type CorpStatistic struct {
SessionCnt int64 `json:"session_cnt"`
CustomerCnt int64 `json:"customer_cnt"`
CustomerMsgCnt int64 `json:"customer_msg_cnt"`
UpgradeServiceCustomerCnt int64 `json:"upgrade_service_customer_cnt"`
AiSessionReplyCnt int64 `json:"ai_session_reply_cnt"`
AiTransferRate float64 `json:"ai_transfer_rate"`
AiKnowledgeHitRate float64 `json:"ai_knowledge_hit_rate"`
MsgRejectedCustomerCnt int64 `json:"msg_rejected_customer_cnt"`
}
// GetCorpStatistic 获取「客户数据统计」企业汇总数据
// see https://developer.work.weixin.qq.com/document/path/95489
func (r *Client) GetCorpStatistic(req *GetCorpStatisticRequest) (*GetCorpStatisticResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getCorpStatisticURL, accessToken), req); err != nil {
return nil, err
}
result := &GetCorpStatisticResponse{}
if err = util.DecodeWithError(response, result, "GetCorpStatistic"); err != nil {
return nil, err
}
return result, nil
}
// GetServicerStatisticRequest 获取「客户数据统计」接待人员明细数据请求
type GetServicerStatisticRequest struct {
OpenKfID string `json:"open_kfid"`
ServicerUserID string `json:"servicer_userid"`
StartTime int64 `json:"start_time"`
EndTime int64 `json:"end_time"`
}
// GetServicerStatisticResponse 获取「客户数据统计」接待人员明细数据响应
type GetServicerStatisticResponse struct {
util.CommonError
StatisticList []ServicerStatisticList `json:"statistic_list"`
}
// ServicerStatisticList 接待人员明细统计数据列表
type ServicerStatisticList struct {
StatTime int64 `json:"stat_time"`
Statistic ServicerStatistic `json:"statistic"`
}
// ServicerStatistic 接待人员明细统计一天的统计数据
type ServicerStatistic struct {
SessionCnt int64 `json:"session_cnt"`
CustomerCnt int64 `json:"customer_cnt"`
CustomerMsgCnt int64 `json:"customer_msg_cnt"`
ReplyRate float64 `json:"reply_rate"`
FirstReplyAverageSec float64 `json:"first_reply_average_sec"`
SatisfactionInvestgateCnt int64 `json:"satisfaction_investgate_cnt"`
SatisfactionParticipationRate float64 `json:"satisfaction_participation_rate"`
SatisfiedRate float64 `json:"satisfied_rate"`
MiddlingRate float64 `json:"middling_rate"`
DissatisfiedRate float64 `json:"dissatisfied_rate"`
UpgradeServiceCustomerCnt int64 `json:"upgrade_service_customer_cnt"`
UpgradeServiceMemberInviteCnt int64 `json:"upgrade_service_member_invite_cnt"`
UpgradeServiceMemberCustomerCnt int64 `json:"upgrade_service_member_customer_cnt"`
UpgradeServiceGroupChatInviteCnt int64 `json:"upgrade_service_groupchat_invite_cnt"`
UpgradeServiceGroupChatCustomerCnt int64 `json:"upgrade_service_groupchat_customer_cnt"`
MsgRejectedCustomerCnt int64 `json:"msg_rejected_customer_cnt"`
}
// GetServicerStatistic 获取「客户数据统计」接待人员明细数据
// see https://developer.work.weixin.qq.com/document/path/95490
func (r *Client) GetServicerStatistic(req *GetServicerStatisticRequest) (*GetServicerStatisticResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getServicerStatisticURL, accessToken), req); err != nil {
return nil, err
}
result := &GetServicerStatisticResponse{}
if err = util.DecodeWithError(response, result, "GetServicerStatistic"); err != nil {
return nil, err
}
return result, nil
}