Documentation
¶
Index ¶
- Constants
- Variables
- type CoinInfo
- type CommonPushData
- type CommonToken
- type ConfirmReceiveMethod
- type CustomerMessage
- func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage
- func NewCustomerLinkMessage(toUser, title, description, url, thumbURL string) *CustomerMessage
- func NewCustomerMiniprogrampageMessage(toUser, title, pagepath, thumbMediaID string) *CustomerMessage
- func NewCustomerTextMessage(toUser, text string) *CustomerMessage
- type DataReceived
- type DramaAuditDetail
- type EventType
- type GoodsInfo
- type InfoType
- type Manager
- type MediaCheckAsyncData
- type MediaCheckAsyncResult
- type MediaCheckDetail
- type MediaLink
- type MediaMiniprogrampage
- type MediaResource
- type MediaText
- type MiniProgramMixMessage
- type MsgType
- type PushData
- type PushDataAddExpressPath
- type PushDataAddExpressPathAction
- type PushDataOrderSettlement
- type PushDataRemindAccessAPI
- type PushDataRemindShipping
- type PushDataSecVodAudit
- type PushDataSecVodUpload
- type PushDataSubscribeMsgChange
- type PushDataSubscribeMsgSent
- type PushDataSubscribePopup
- type PushDataXpayCoinPayNotify
- type PushDataXpayGoodsDeliverNotify
- type PushReceiver
- type Reply
- type SecVodAuditEvent
- type SecVodUploadEvent
- type SubscribeMsgChangeEvent
- type SubscribeMsgChangeList
- type SubscribeMsgPopupEvent
- type SubscribeMsgPopupEventList
- type SubscribeMsgSentEvent
- type SubscribeMsgSentList
- type WeChatPayInfo
Constants ¶
const ( // MsgTypeText 文本消息 MsgTypeText MsgType = "text" // MsgTypeImage 图片消息 MsgTypeImage = "image" // MsgTypeLink 图文链接 MsgTypeLink = "link" // MsgTypeMiniProgramPage 小程序卡片 MsgTypeMiniProgramPage = "miniprogrampage" // MsgTypeEvent 事件 MsgTypeEvent MsgType = "event" // DataTypeXML XML 格式数据 DataTypeXML = "xml" // DataTypeJSON JSON 格式数据 DataTypeJSON = "json" )
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" // EventSubscribePopup 用户操作订阅通知弹窗事件推送,用户在图文等场景内订阅通知的操作 EventSubscribePopup EventType = "subscribe_msg_popup_event" // EventSubscribeMsgChange 用户管理订阅通知,用户在服务通知管理页面做通知管理时的操作 EventSubscribeMsgChange EventType = "subscribe_msg_change_event" // EventSubscribeMsgSent 发送订阅通知,调用 bizsend 接口发送通知 EventSubscribeMsgSent EventType = "subscribe_msg_sent_event" // ConfirmReceiveMethodAuto 自动确认收货 ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1 // ConfirmReceiveMethodManual 手动确认收货 ConfirmReceiveMethodManual ConfirmReceiveMethod = 2 )
Variables ¶
var ErrInvalidReply = errors.New("无效的回复信息")
ErrInvalidReply 无效的回复
var ErrUnsupportedReply = errors.New("不支持的回复消息")
ErrUnsupportedReply 不支持的回复类型
Functions ¶
This section is empty.
Types ¶
type CoinInfo ¶ added in v2.1.6
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"` // 透传信息
}
CoinInfo 代币参数信息
type CommonPushData ¶ added in v2.1.6
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"` // 消息创建时间(整型),时间戳
}
CommonPushData 推送数据通用部分
type CommonToken ¶
type CommonToken struct {
XMLName xml.Name `xml:"xml"`
ToUserName string `xml:"ToUserName"`
FromUserName string `xml:"FromUserName"`
CreateTime int64 `xml:"CreateTime"`
MsgType MsgType `xml:"MsgType"`
}
CommonToken 消息中通用的结构
type ConfirmReceiveMethod ¶ added in v2.1.6
type ConfirmReceiveMethod int8
ConfirmReceiveMethod 确认收货方式
type CustomerMessage ¶
type CustomerMessage struct {
ToUser string `json:"touser"` // 接受者 OpenID
Msgtype MsgType `json:"msgtype"` // 客服消息类型
Text *MediaText `json:"text,omitempty"` // 可选
Image *MediaResource `json:"image,omitempty"` // 可选
Link *MediaLink `json:"link,omitempty"` // 可选
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
}
CustomerMessage 客服消息
func NewCustomerImgMessage ¶
func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage
NewCustomerImgMessage 图片消息的构造方法
func NewCustomerLinkMessage ¶
func NewCustomerLinkMessage(toUser, title, description, url, thumbURL string) *CustomerMessage
NewCustomerLinkMessage 图文链接消息的构造方法
func NewCustomerMiniprogrampageMessage ¶
func NewCustomerMiniprogrampageMessage(toUser, title, pagepath, thumbMediaID string) *CustomerMessage
NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
func NewCustomerTextMessage ¶
func NewCustomerTextMessage(toUser, text string) *CustomerMessage
NewCustomerTextMessage 文本消息结构体构造方法
type DataReceived ¶ added in v2.1.6
type DataReceived struct {
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
}
DataReceived 接收到的数据
type DramaAuditDetail ¶ added in v2.1.6
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"` // 审核时间戳
}
DramaAuditDetail 剧目审核结果
type GoodsInfo ¶ added in v2.1.6
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"` // 透传信息
}
GoodsInfo 道具参数信息
type Manager ¶
Manager 消息管理者,可以发送消息
func NewCustomerMessageManager ¶
NewCustomerMessageManager 实例化消息管理者
type MediaCheckAsyncData ¶ added in v2.1.6
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"`
}
MediaCheckAsyncData 媒体内容安全异步审查结果通知
type MediaCheckAsyncResult ¶ added in v2.1.6
type MediaCheckAsyncResult struct {
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
Label security.CheckLabel `json:"label" xml:"label"`
}
MediaCheckAsyncResult 检测结果
type MediaCheckDetail ¶ added in v2.1.6
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"`
}
MediaCheckDetail 检测结果详情
type MediaLink ¶
type MediaLink struct {
Title string `json:"title"`
Description string `json:"description"`
URL string `json:"url"`
ThumbURL string `json:"thumb_url"`
}
MediaLink 发送图文链接
type MediaMiniprogrampage ¶
type MediaMiniprogrampage struct {
Title string `json:"title"`
Appid string `json:"appid"`
Pagepath string `json:"pagepath"`
ThumbMediaID string `json:"thumb_media_id"`
}
MediaMiniprogrampage 小程序卡片
type MediaResource ¶
type MediaResource struct {
MediaID string `json:"media_id"`
}
MediaResource 消息使用的临时素材 id
type MiniProgramMixMessage ¶
type MiniProgramMixMessage struct {
CommonToken
MsgID int64 `xml:"MsgId"`
// 文本消息
Content string `xml:"Content"`
// 图片消息
PicURL string `xml:"PicUrl"`
MediaID string `xml:"MediaId"`
// 小程序卡片消息
Title string `xml:"Title"`
AppID string `xml:"AppId"`
PagePath string `xml:"PagePath"`
ThumbURL string `xml:"ThumbUrl"`
ThumbMediaID string `xml:"ThumbMediaId"`
// 进入会话事件
Event string `xml:"Event"`
SessionFrom string `xml:"SessionFrom"`
}
MiniProgramMixMessage 小程序回调的消息结构
type PushDataAddExpressPath ¶ added in v2.1.6
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"` // 轨迹节点列表
}
PushDataAddExpressPath 运单轨迹更新信息
type PushDataAddExpressPathAction ¶ added in v2.1.6
type PushDataAddExpressPathAction struct {
ActionTime int64 `json:"ActionTime" xml:"ActionTime"` // 轨迹节点 Unix 时间戳
ActionType int `json:"ActionType" xml:"ActionType"` // 轨迹节点类型
ActionMsg string `json:"ActionMsg" xml:"ActionMsg"` // 轨迹节点详情
}
PushDataAddExpressPathAction 轨迹节点
type PushDataOrderSettlement ¶ added in v2.1.6
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"` // 订单结算时间,秒级时间戳。结算时推送才有该字段
}
PushDataOrderSettlement 订单将要结算或已经结算通知
type PushDataRemindAccessAPI ¶ added in v2.1.6
type PushDataRemindAccessAPI struct {
CommonPushData
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
PushDataRemindAccessAPI 提醒接入发货信息管理服务 API 信息
type PushDataRemindShipping ¶ added in v2.1.6
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"` // 消息文本内容
}
PushDataRemindShipping 提醒需要上传发货信息
type PushDataSecVodAudit ¶ added in v2.1.6
type PushDataSecVodAudit struct {
CommonPushData
AuditEvent SecVodAuditEvent `json:"audit_event" xml:"audit_event"` // 审核状态事件
}
PushDataSecVodAudit 短剧媒资审核状态
type PushDataSecVodUpload ¶ added in v2.1.6
type PushDataSecVodUpload struct {
CommonPushData
UploadEvent SecVodUploadEvent `json:"upload_event" xml:"upload_event"` // 上传完成事件
}
PushDataSecVodUpload 短剧媒资上传完成
type PushDataSubscribeMsgChange ¶ added in v2.1.6
type PushDataSubscribeMsgChange struct {
CommonPushData
SubscribeMsgChangeEvent SubscribeMsgChangeEvent `xml:"SubscribeMsgChangeEvent"`
// contains filtered or unexported fields
}
PushDataSubscribeMsgChange 用户管理订阅通知事件推送
func (*PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents ¶ added in v2.1.6
func (s *PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents() []SubscribeMsgChangeList
GetSubscribeMsgChangeEvents 获取订阅消息事件数据
func (*PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents ¶ added in v2.1.6
func (s *PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents(list []SubscribeMsgChangeList)
SetSubscribeMsgChangeEvents 设置订阅消息事件
type PushDataSubscribeMsgSent ¶ added in v2.1.6
type PushDataSubscribeMsgSent struct {
CommonPushData
SubscribeMsgSentEvent SubscribeMsgSentEvent `xml:"SubscribeMsgSentEvent"`
// contains filtered or unexported fields
}
PushDataSubscribeMsgSent 用户发送订阅通知事件推送
func (*PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents ¶ added in v2.1.6
func (s *PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents() []SubscribeMsgSentList
GetSubscribeMsgSentEvents 获取订阅消息事件数据
func (*PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents ¶ added in v2.1.6
func (s *PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents(list []SubscribeMsgSentList)
SetSubscribeMsgSentEvents 设置订阅消息事件
type PushDataSubscribePopup ¶ added in v2.1.6
type PushDataSubscribePopup struct {
CommonPushData
SubscribeMsgPopupEvent SubscribeMsgPopupEvent `xml:"SubscribeMsgPopupEvent"`
// contains filtered or unexported fields
}
PushDataSubscribePopup 用户操作订阅通知弹窗事件推送
func (*PushDataSubscribePopup) GetSubscribeMsgPopupEvents ¶ added in v2.1.6
func (s *PushDataSubscribePopup) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEventList
GetSubscribeMsgPopupEvents 获取订阅消息事件数据
func (*PushDataSubscribePopup) SetSubscribeMsgPopupEvents ¶ added in v2.1.6
func (s *PushDataSubscribePopup) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEventList)
SetSubscribeMsgPopupEvents 设置订阅消息事件
type PushDataXpayCoinPayNotify ¶ added in v2.1.6
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"` // 代币参数信息
}
PushDataXpayCoinPayNotify 代币支付推送
type PushDataXpayGoodsDeliverNotify ¶ added in v2.1.6
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"` // 道具参数信息
}
PushDataXpayGoodsDeliverNotify 道具发货推送
type PushReceiver ¶ added in v2.1.6
PushReceiver 接收消息推送 暂仅支付 Aes 加密方式
func NewPushReceiver ¶ added in v2.1.6
func NewPushReceiver(ctx *context.Context) *PushReceiver
NewPushReceiver 实例化
func (*PushReceiver) GetMsgData ¶ added in v2.1.6
GetMsgData 获取接收到的消息 (解密数据)
type SecVodAuditEvent ¶ added in v2.1.6
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 查询剧集详情得到
}
SecVodAuditEvent 短剧媒资审核状态事件
type SecVodUploadEvent ¶ added in v2.1.6
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"` // 错误提示
}
SecVodUploadEvent 短剧媒资上传完成事件
type SubscribeMsgChangeEvent ¶ added in v2.1.6
type SubscribeMsgChangeEvent struct {
List []SubscribeMsgChangeList `xml:"List" json:"List"`
}
SubscribeMsgChangeEvent 用户管理订阅通知回调
type SubscribeMsgChangeList ¶ added in v2.1.6
type SubscribeMsgChangeList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
}
SubscribeMsgChangeList 订阅消息事件列表
type SubscribeMsgPopupEvent ¶ added in v2.1.6
type SubscribeMsgPopupEvent struct {
List []SubscribeMsgPopupEventList `xml:"List"`
}
SubscribeMsgPopupEvent 用户操作订阅通知弹窗消息回调
type SubscribeMsgPopupEventList ¶ added in v2.1.6
type SubscribeMsgPopupEventList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
PopupScene string `xml:"PopupScene" json:"PopupScene"`
}
SubscribeMsgPopupEventList 订阅消息事件列表
type SubscribeMsgSentEvent ¶ added in v2.1.6
type SubscribeMsgSentEvent struct {
List []SubscribeMsgSentList `xml:"List" json:"List"`
}
SubscribeMsgSentEvent 用户发送订阅通知回调
type SubscribeMsgSentList ¶ added in v2.1.6
type SubscribeMsgSentList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
MsgID string `xml:"MsgID" json:"MsgID"`
ErrorCode int `xml:"ErrorCode" json:"ErrorCode"`
ErrorStatus string `xml:"ErrorStatus" json:"ErrorStatus"`
}
SubscribeMsgSentList 订阅消息事件列表
type WeChatPayInfo ¶ added in v2.1.6
type WeChatPayInfo struct {
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间,Linux 秒级时间戳
}
WeChatPayInfo 微信支付信息