wxworkfinancesdk

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Apr 16, 2024 License: GPL-3.0 Imports: 14 Imported by: 0

README

企业微信会话内容存档SDK golang版

Go Reference Go goreleaser GitHub go.mod Go version of a Go module GoReportCard GitHub license GitHub release

用于拉取企业聊天记录与媒体消息，该SDK是对官方linux c库的封装

Usage

package main

import (
    "log"
    "fmt"
    "bytes"

    sdk "github.com/bububa/WeWorkFinanceSDK"
)

func main() {
    corpId := "企业ID"
    corpSecret := "secret"
    clt, err := sdk.NewClient(corpId, corpSecret)
    if err != nil {
        log.Fatalln(err)
    }
    defer clt.Destroy()
    var (
        seq uint64 
        limit uint64 = 1000
        proxy = ""
        passwd = ""
        timeout = 300
    )
    for {
        chatsData, err := clt.GetChatData(seq, limit, proxy, passwd, timeout)
        if err != nil {
            log.Fatalln(err)
        }
        if len(chatsData) == 0 {
            break
        }
        // iterate chatsData
        for _, data := range chatsData {
            // update seq with chatdata.Seq for next loop
            seq = data.Seq
            // decrypt chat data
            msg, err := clt.DecryptData(data.EncryptRandomKey, data.EncryptChatMsg)
            if err != nil {
                log.Fatalln(err)
                continue
            }
            fmt.Printf("msg: %+v\n", msg)
            if msg.MessageType() == sdk.IMG_MSG {
                var (
                    w = new(bytes.Buffer) 
                    sdkField = msg.(sdk.ImageMessage).SdkFileId
                )
                err := clt.DownloadMedia(w, sdkField, proxy, passwd, timeout)
                if err != nil {
                    log.Fatalln(err)
                    continue
                }
                log.Printf("download mediadata, len:%d bytes\n", w.Len())
            }
        }
    }
}

Reference

企业微信获取会话内容文档

Documentation

Overview

Package wxworkfinancesdk 企业内容存档SDK

Index

Constants

View Source 
const (
	// SDKErrMsg 错误消息
	// SDKInitErrMsg sdk 初始化失败
	SDKInitErrMsg = "sdk init failed"
	// GetChatDataErrMsg 调用 GetChatData API 失败
	GetChatDataErrMsg = "call GetChatData failed"
	// DecryptErrMsg 调用 DecryptMessage API 失败
	DecryptErrMsg = "call DecryptMessage API failed"
	// GetMediaDataErrMsg 调用 GetMediaData API 失败
	GetMediaDataErrMsg = "call GetMediaData API failed"
)

Variables

This section is empty.

Functions

func BufferPool added in v1.1.0 

func BufferPool() *bytes.Buffer

func BufferPoolRelease added in v1.1.0 

func BufferPoolRelease(v *bytes.Buffer)

func MediaDataPoolRelease added in v1.1.0 

func MediaDataPoolRelease(m *MediaData)

func RSADecrypt 

func RSADecrypt(privateKey []byte, ciphertext []byte) ([]byte, error)

RSADecrypt RSA解密

func RSADecryptBase64 

func RSADecryptBase64(privateKey []byte, cryptoText string) ([]byte, error)

RSADecryptBase64 base64decode后RSA解密

func RSAEncrypt 

func RSAEncrypt(publicKey []byte, origData []byte) ([]byte, error)

RSAEncrypt RSA加密

func RSAEncryptBase64 

func RSAEncryptBase64(publicKey []byte, origData []byte) (string, error)

RSAEncryptBase64 RSA加密后base64encode

func RSASignWithSHA1 

func RSASignWithSHA1(privateKey []byte, data []byte) ([]byte, error)

RSASignWithSHA1 RSA-SHA1签名

func RSASignWithSHA1Base64 

func RSASignWithSHA1Base64(privateKey []byte, data []byte) (string, error)

RSASignWithSHA1Base64 RSA-SHA1签名后做base64encode

func RSAVerifySignWithSha1 

func RSAVerifySignWithSha1(publicKey []byte, origData []byte, signData string) error

RSAVerifySignWithSha1 RSA-SHA1签名验证

func ReaderPool added in v1.1.0 

func ReaderPool(bs []byte) *bytes.Reader

func ReaderPoolRelease added in v1.1.0 

func ReaderPoolRelease(r *bytes.Reader)

func Sha1Sum 

func Sha1Sum(data []byte) []byte

Sha1Sum SHA1

Types

type ActionType 

type ActionType = string

ActionType // 消息动作 

const (
	// SEND_ACTION 发送消息
	SEND_ACTION ActionType = "send"
	// RECALL_ACTION 撤回消息
	RECALL_ACTION ActionType = "recall"
	// SWITCH_ACTION 切换企业日志
	SWITCH_ACTION ActionType = "switch"
)

type AggreeMessage 

type AggreeMessage struct {
	BaseMessage
	// UserId 同意/不同意协议者的userid，外部企业默认为external_userid。
	UserId string `json:"userid,omitempty"`
	// AgreeTime 同意/不同意协议的时间，utc时间，ms单位。
	AgreeTime int64 `json:"agree_time,omitempty"`
}

AggreeMessage 同意会话消息

type BaseMessage 

type BaseMessage struct {
	// MsgId 消息id，消息的唯一标识，企业可以使用此字段进行消息去重。
	MsgId string `json:"msgid,omitempty"`
	// Action 消息动作，目前有send(发送消息)/recall(撤回消息)/switch(切换企业日志)三种类型。
	Action ActionType `json:"action,omitempty"`
	// From 消息发送方id。同一企业内容为userid，非相同企业为external_userid。消息如果是机器人发出，也为external_userid。
	From string `json:"from,omitempty"`
	// ToList 消息接收方列表，可能是多个，同一个企业内容为userid，非相同企业为external_userid。
	ToList []string `json:"tolist,omitempty"`
	// RoomId 群聊消息的群id。如果是单聊则为空。
	RoomId string `json:"roomid,omitempty"`
	// MsgTime 消息发送时间戳，utc时间，ms单位。
	MsgTime int64 `json:"msgtime,omitempty"`
	// MsgType 文本消息为：text。
	MsgType MessageType `json:"msgtype,omitempty"`
}

BaseMessage 会话消息公共字段

func (BaseMessage) ActionType 

func (m BaseMessage) ActionType() ActionType

ActionType Message interface

func (BaseMessage) ID 

func (m BaseMessage) ID() string

ID implement Message interface

func (BaseMessage) MessageType 

func (m BaseMessage) MessageType() MessageType

MessageType implement Message interface

type CalendarMessage 

type CalendarMessage struct {
	BaseMessage
	// Title 日程主题
	Title string `json:"title,omitempty"`
	// CreatorName 日程组织者
	CreatorName string `json:"creatorname,omitempty"`
	// AttendeeName 日程参与人。数组，内容为String类型
	AttendeeName []string `json:"attendeename,omitempty"`
	// StartTime 日程开始时间。Utc时间，单位秒
	StartTime int64 `json:"starttime,omitempty"`
	// EndTime 日程结束时间。Utc时间，单位秒
	EndTime int64 `json:"endtime,omitempty"`
	// Place 日程地点
	Place string `json:"place,omitempty"`
	// Remarks 日程备注
	Remarks string `json:"remarks,omitempty"`
}

CalendarMessage 日程消息

type CardMessage 

type CardMessage struct {
	BaseMessage
	// CorpName 名片所有者所在的公司名称。
	CorpName string `json:"corpname,omitempty"`
	// UserId 名片所有者的id，同一公司是userid，不同公司是external_userid
	UserId string `json:"userid,omitempty"`
}

CardMessage 名片消息

type ChatData 

type ChatData struct {
	// Seq 消息的seq值，标识消息的序号。再次拉取需要带上上次回包中最大的seq。Uint64类型，范围0-pow(2,64)-1
	Seq uint64 `json:"seq,omitempty"`
	// MsgId 消息id，消息的唯一标识，企业可以使用此字段进行消息去重。
	MsgId string `json:"msgid,omitempty"`
	// PublickeyVer 加密此条消息使用的公钥版本号。
	PublickeyVer uint32 `json:"publickey_ver,omitempty"`
	// EncryptRandomKey 使用publickey_ver指定版本的公钥进行非对称加密后base64加密的内容，需要业务方先base64 decode处理后，再使用指定版本的私钥进行解密，得出内容。
	EncryptRandomKey string `json:"encrypt_random_key,omitempty"`
	// EncryptChatMsg 消息密文。需要业务方使用将encrypt_random_key解密得到的内容，与encrypt_chat_msg，传入sdk接口DecryptData,得到消息明文。
	EncryptChatMsg string `json:"encrypt_chat_msg,omitempty"`
}

ChatData 加密消息数据

type ChatDataResponse 

type ChatDataResponse struct {
	Error
	ChatDataList []ChatData `json:"chatdata,omitempty"`
}

ChatDataResponse 拉去消息返回值

func (ChatDataResponse) IsError 

func (r ChatDataResponse) IsError() bool

IsError 判断是否错误

type ChatRecord 

type ChatRecord struct {
	// Type  每条聊天记录的具体消息类型：ChatRecordText/ ChatRecordFile/ ChatRecordImage/ ChatRecordVideo/ ChatRecordLink/ ChatRecordLocation/ ChatRecordMixed ….
	Type ChatRecordType `json:"type,omitempty"`
	// Content 消息内容。Json串，内容为对应类型的json
	Content string `json:"content,omitempty"`
	// MsgTime 消息时间，utc时间，ms单位。
	MsgTime int64 `json:"msgtime,omitempty"`
	// FromChatroom 是否来自群会话。
	FromChatroom bool `json:"from_chatroom,omitempty"`
}

ChatRecord 消息记录内的消息内

type ChatRecordMessage 

type ChatRecordMessage struct {
	BaseMessage
	// Title 聊天记录标题
	Title string `json:"title,omitempty"`
	// Item 消息记录内的消息内容，批量数据
	Item []ChatRecord `json:"item,omitempty"`
}

ChatRecordMessage 聊天记录消息

type ChatRecordType 

type ChatRecordType = string

ChatRecordType 每条聊天记录的具体消息类型 

const (
	// TEXT_REC_MSG 文本消息
	TEXT_REC_MSG ChatRecordType = "ChatRecordText"
	// IMG_REC_MSG 图片消息
	IMG_REC_MSG ChatRecordType = "ChatRecordImage"
	// VOICE_REC_MSG 语音消息
	VOICE_REC_MSG ChatRecordType = "ChatRecordVoice"
	// VIDEO_REC_MSG 视频消息
	VIDEO_REC_MSG ChatRecordType = "ChatRecordVideo"
	// CARD_REC_MSG 名片消息
	CARD_REC_MSG ChatRecordType = "ChatRecordCard"
	// LOC_REC_MSG 位置消息
	LOC_REC_MSG ChatRecordType = "ChatRecordLocation"
	// EMOTION_REC_MSG 表情消息
	EMOTION_REC_MSG ChatRecordType = "ChatRecordEmotion"
	// FILE_REC_MSG 文件消息
	FILE_REC_MSG ChatRecordType = "ChatRecordFile"
	// LINK_REC_MSG 链接消息
	LINK_REC_MSG ChatRecordType = "ChatRecordLink"
	// WEAPP_REC_MSG 小程序消息
	WEAPP_REC_MSG ChatRecordType = "ChatRecordWeapp"
	// MIXED_REC_MSG 混合消息
	MIXED_REC_MSG ChatRecordType = "ChatRecordMixed"
)

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client Client对象

func NewClient 

func NewClient(corpId string, corpSecret string) (*Client, error)

NewClient 初始化函数 @param [in] corpid 调用企业的企业id，例如：wwd08c8exxxx5ab44d，可以在企业微信管理端--我的企业--企业信息查看 @param [in] secret 聊天内容存档的Secret，可以在企业微信管理端--管理工具--聊天内容存档查看

func (*Client) DecryptData 

func (c *Client) DecryptData(encryptKey string, encryptMsg string) (Message, error)

DecryptData 解析密文.企业微信自有解密内容 @param [in] encrypt_key, getchatdata返回的encrypt_random_key,使用企业自持对应版本秘钥RSA解密后的内容 @param [in] encrypt_msg, getchatdata返回的encrypt_chat_msg @return msg, 解密的消息明文

func (*Client) Destroy added in v1.1.1 

func (c *Client) Destroy()

Destroy 释放sdk，和NewClient成对使用

func (*Client) DownloadMedia 

func (c *Client) DownloadMedia(w io.Writer, sdkFileId string, proxy string, passwd string, timeout int) error

DownloadMedia 下载MediaData

func (*Client) DownloadMediaZeroAlloc added in v1.1.0 

func (c *Client) DownloadMediaZeroAlloc(w io.Writer, sdkFileId string, proxy string, passwd string, timeout int) error

DownloadMediaZeroAlloc 下载MediaData zero mem alloc version

func (*Client) GetChatData 

func (c *Client) GetChatData(seq uint64, limit uint64, proxy string, passwd string, timeout int) ([]ChatData, error)

GetChatData 拉取聊天记录函数

@param [in] seq 从指定的seq开始拉取消息，注意的是返回的消息从seq+1开始返回，seq为之前接口返回的最大seq值。首次使用请使用seq:0 @param [in] limit 一次拉取的消息条数，最大值1000条，超过1000条会返回错误 @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 @param [in] timeout 超时时间，单位秒 @return chatDatas 返回本次拉取消息的数据，slice结构体.内容包括errcode/errmsg，以及每条消息内容。示例如下：

{"errcode":0,"errmsg":"ok","chatdata":[{"seq":196,"msgid":"CAQQ2fbb4QUY0On2rYSAgAMgip/yzgs=","publickey_ver":3,"encrypt_random_key":"ftJ+uz3n/z1DsxlkwxNgE+mL38H42/KCvN8T60gbbtPD+Rta1hKTuQPzUzO6Hzne97MgKs7FfdDxDck/v8cDT6gUVjA2tZ/M7euSD0L66opJ/IUeBtpAtvgVSD5qhlaQjvfKJc/zPMGNK2xCLFYqwmQBZXbNT7uA69Fflm512nZKW/piK2RKdYJhRyvQnA1ISxK097sp9WlEgDg250fM5tgwMjujdzr7ehK6gtVBUFldNSJS7ndtIf6aSBfaLktZgwHZ57ONewWq8GJe7WwQf1hwcDbCh7YMG8nsweEwhDfUz+u8rz9an+0lgrYMZFRHnmzjgmLwrR7B/32Qxqd79A==","encrypt_chat_msg":"898WSfGMnIeytTsea7Rc0WsOocs0bIAerF6de0v2cFwqo9uOxrW9wYe5rCjCHHH5bDrNvLxBE/xOoFfcwOTYX0HQxTJaH0ES9OHDZ61p8gcbfGdJKnq2UU4tAEgGb8H+Q9n8syRXIjaI3KuVCqGIi4QGHFmxWenPFfjF/vRuPd0EpzUNwmqfUxLBWLpGhv+dLnqiEOBW41Zdc0OO0St6E+JeIeHlRZAR+E13Isv9eS09xNbF0qQXWIyNUi+ucLr5VuZnPGXBrSfvwX8f0QebTwpy1tT2zvQiMM2MBugKH6NuMzzuvEsXeD+6+3VRqL"}]}

func (Client) GetContentFromSlice 

func (c Client) GetContentFromSlice(slice *C.struct_Slice_t, buf *bytes.Buffer)

GetContentFromSlice 转换C.struct_Slice_t为go bytes

func (*Client) GetMediaData 

func (c *Client) GetMediaData(indexBuf string, sdkFileId string, proxy string, passwd string, timeout int, data *MediaData) error

GetMediaData 拉取媒体消息函数 Return值=0表示该API调用成功

@param [in] sdkFileid 从GetChatData返回的聊天消息中，媒体消息包括的sdkfileid @param [in] proxy 使用代理的请求，需要传入代理的链接。如：socks5://10.0.0.1:8081 或者 http://10.0.0.1:8081 @param [in] passwd 代理账号密码，需要传入代理的账号密码。如 user_name:passwd_123 @param [in] indexbuf 媒体消息分片拉取，需要填入每次拉取的索引信息。首次不需要填写，默认拉取512k，后续每次调用只需要将上次调用返回的outindexbuf填入即可。 @param [in] timeout 超时时间，单位秒 @return media_data 返回本次拉取的媒体数据.MediaData结构体.内容包括data(数据内容)/outindexbuf(下次索引)/is_finish(拉取完成标记)

type CollectDetails 

type CollectDetails struct {
	// Id 表项id
	Id uint64 `json:"id,omitempty"`
	// Ques 表项名称
	Ques string `json:"ques,omitempty"`
	// Type 表项类型，有Text(文本),Number(数字),Date(日期),Time(时间)
	Type CollectDetailsType `json:"type,omitempty"`
}

CollectDetails 填表消息表内容

type CollectDetailsType 

type CollectDetailsType = string

CollectDetailsType 表项类型 

const (
	// TEXT 文本
	TEXT CollectDetailsType = "Text"
	// NUMBER 数字
	NUMBER CollectDetailsType = "Number"
	// DATE 日期
	DATE CollectDetailsType = "Date"
	// TIME 时间
	TIME CollectDetailsType = "Time"
)

type CollectMessage 

type CollectMessage struct {
	BaseMessage
	// RoomName 填表消息所在的群名称。
	RoomName string `json:"room_name,omitempty"`
	// Creator 创建者在群中的名字
	Creator string `json:"creator,omitempty"`
	// CreateTime 创建的时间
	CreateTime string `json:"create_time,omitempty"`
	// Details 表内容
	Details []CollectDetails `json:"details,omitempty"`
}

CollectMessage 填表消息

type DemoFileData 

type DemoFileData struct {
	// FileName 文档共享名称
	FileName string `json:"filename,omitempty"`
	// DemoOperator 文档共享操作用户的id
	DemoOperator string `json:"demooperator,omitempty"`
	// StartTime 文档共享开始时间
	StartTime int64 `json:"starttime,omitempty"`
	// EndTime 文档共享结束时间
	EndTime int64 `json:"endtime,omitempty"`
}

DemoFileData 文档分享对

type DocMessage 

type DocMessage struct {
	BaseMessage
	// Title 在线文档名称
	Title string `json:"title,omitempty"`
	// LinkUrl 在线文档链接
	LinkUrl string `json:"link_url,omitempty"`
	// DocCreator 在线文档创建者。本企业成员创建为userid；外部企业成员创建为external_userid
	DocCreator string `json:"doc_creator,omitempty"`
}

DocMessage 在线文档消息

type EmotionMessage 

type EmotionMessage struct {
	BaseMessage
	// Type 表情类型，png或者gif.1表示gif 2表示png。
	Type EmotionType `json:"type,omitempty"`
	// Width 表情图片宽度。
	Width uint32 `json:"width,omitempty"`
	// Height 表情图片高度。
	Height uint32 `json:"height,omitempty"`
	// ImageSize 资源的文件大小。
	ImageSize uint32 `json:"imagesize,omitempty"`
	// SdkFileId 媒体资源的id信息。
	SdkFileId string `json:"sdkfileid,omitempty"`
	// Md5Sum 图片资源的md5值，供进行校验。
	Md5Sum string `json:"md5sum,omitempty"`
}

EmotionMessage 表情消息

type EmotionType 

type EmotionType = uint32

EmotionType 表情类型 

const (
	// GIF gif表情
	GIF EmotionType = 1
	// PNG png表情
	PNG EmotionType = 2
)

type Error 

type Error struct {
	// ErrCode 错误代码
	ErrCode int `json:"errcode,omitempty"`
	// ErrMsg 错误说明
	ErrMsg string `json:"errmsg,omitempty"`
	Hint   string `json:"hint,omitempty"`
}

Error SDK Error结构体

func NewSDKErr 

func NewSDKErr(code int, msg string) Error

NewSDKErr 新建错误

func (Error) Error 

func (e Error) Error() string

Error implement error interface

type FileMessage 

type FileMessage struct {
	BaseMessage
	// FileName 文件名称。
	FileName string `json:"filename,omitempty"`
	// FileExt 文件类型后缀。
	FileExt string `json:"fileext,omitempty"`
	// SdkFileId 媒体资源的id信息。
	SdkFileId string `json:"sdkfileid,omitempty"`
	// FileSize 文件大小。
	FileSize uint32 `json:"filesize,omitempty"`
	// Md5Sum 资源的md5值，供进行校验。
	Md5Sum string `json:"md5sum,omitempty"`
}

FileMessage 文件消息

type ImageMessage 

type ImageMessage struct {
	BaseMessage
	// SdkFileId 媒体资源的id信息。
	SdkFileId string `json:"sdkfileid,omitempty"`
	// Md5Sum 图片资源的md5值，供进行校验。
	Md5Sum string `json:"md5sum,omitempty"`
	// FileSize 图片资源的文件大小。
	FileSize uint32 `json:"filesize,omitempty"`
}

ImageMessage 图片消息

type LinkMessage 

type LinkMessage struct {
	BaseMessage
	// Title 消息标题。
	Title string `json:"title,omitempty"`
	// Desc 消息描述。
	Desc string `json:"description,omitempty"`
	// LinkUrl 链接url地址
	LinkUrl string `json:"link_url,omitempty"`
	// ImageUrl 链接图片url。
	ImageUrl string `json:"image_url,omitempty"`
}

LinkMessage 链接消息

type LocationMessage 

type LocationMessage struct {
	BaseMessage
	// Lng 经度，单位double
	Lng float64 `json:"longitude,omitempty"`
	// Lat 纬度，单位double
	Lat float64 `json:"latitude,omitempty"`
	// Address 地址信息
	Address string `json:"address,omitempty"`
	// Title 位置信息的title。
	Title string `json:"title,omitempty"`
	// Zoom 缩放比例。
	Zoom uint32 `json:"zoom,omitempty"`
}

LocationMessage 位置消息

type MarkdownMessage 

type MarkdownMessage struct {
	BaseMessage
	// Content markdown消息内容，目前为机器人发出的消息
	Content string `json:"content,omitempty"`
}

MarkdownMessage MarkDown格式消息

type MediaData 

type MediaData struct {
	OutIndexBuf string `json:"outindexbuf,omitempty"` // 消息分片索引信息
	IsFinish    bool   `json:"is_finish,omitempty"`   //
	Data        []byte `json:"data,omitempty"`        // 媒体数据内通
}

MediaData 媒体消息结构体

func MediaDataPool added in v1.1.0 

func MediaDataPool() *MediaData

type MeetingMessage 

type MeetingMessage struct {
	BaseMessage
	// Topic 会议主题
	Topic string `json:"topic,omitempty"`
	// StartTime 会议开始时间。Utc时间
	StartTime int64 `json:"starttime,omitempty"`
	// EndTime 会议结束时间。Utc时间
	EndTime int64 `json:"endtime,omitempty"`
	// Address 会议地址
	Address string `json:"address,omitempty"`
	// Remarks 会议备注
	Remarks string `json:"remarks,omitempty"`
	// MeetingType 会议消息类型。101发起会议邀请消息、102处理会议邀请消息
	MeetingType MeetingType `json:"meetingtype,omitempty"`
	// MeetingId 会议id。方便将发起、处理消息进行对照
	MeetingId uint64 `json:"meetingid,omitempty"`
	// Status 会议邀请处理状态。1 参加会议、2 拒绝会议、3 待定、4 未被邀请、5 会议已取消、6 会议已过期、7 不在房间内。
	Status MeetingStatus `json:"status,omitempty"`
}

MeetingMessage 会议邀请消息

type MeetingStatus 

type MeetingStatus = uint32

MeetingStatus 会议邀请处理状态 

const (
	// JOIN_MEETING 参加会议
	JOIN_MEETING MeetingStatus = 1
	// REJECT_MEETING 绝会议
	REJECT_MEETING MeetingStatus = 2
	// PENDING_MEETING 待定
	PENDING_MEETING MeetingStatus = 3
	// NOINVITE_MEETING 未被邀请
	NOINVITE_MEETING MeetingStatus = 4
	// CANCELED_MEETING 会议已取消
	CANCELED_MEETING MeetingStatus = 5
	// EXPIRED_MEETING 会议已过期
	EXPIRED_MEETING MeetingStatus = 6
	// ABSENT_MEETING 不在房间内
	ABSENT_MEETING MeetingStatus = 7
)

type MeetingType 

type MeetingType = uint32

MeetingType 会议消息类型 

const (
	// LAUNCH_MEETING 发起会议邀请消息
	LAUNCH_MEETING MeetingType = 101
	// HANDLE_MEETING 处理会议邀请消息
	HANDLE_MEETING MeetingType = 102
)

type MeetingVoiceCall 

type MeetingVoiceCall struct {
	// EndTime 音频结束时间
	EndTime int64 `json:"endtime,omitempty"`
	// SdkFileId 音频媒体下载的id
	SdkFileId string `json:"sdkfileid,omitempty"`
	// DemoFileData 文档分享对象，Object类型
	DemoFileData []DemoFileData `json:"demofiledata,omitempty"`
	// ShareScreenData 屏幕共享对象，Object类型
	ShareScreenData []ShareScreenData `json:"sharescreendata,omitempty"`
}

MeetingVoiceCall 音频消息内

type MeetingVoiceCallMessage 

type MeetingVoiceCallMessage struct {
	BaseMessage
	// VoiceId 音频id
	VoiceId string `json:"voiceid,omitempty"`
	// MeetingVoiceCall 音频消息内容。包括结束时间、fileid，可能包括多个demofiledata、sharescreendata消息，demofiledata表示文档共享信息，sharescreendata表示屏幕共享信息。Object类型
	MeetingVoiceCall *MeetingVoiceCall `json:"meeting_voice_call,omitempty"`
}

MeetingVoiceCallMessage 音频存档消息

type Message 

type Message interface {
	// ID 消息ID
	ID() string
	// MessageType 消息类型
	MessageType() MessageType
	// ActionType 消息动作类型
	ActionType() ActionType
}

Message 会话消息

type MessageType 

type MessageType = string

MessageType 消息类型 

const (
	// UNKNOWN_MSG 未定义
	UNKNOWN_MSG MessageType = ""
	// TEXT_MSG 文本消息
	TEXT_MSG MessageType = "text"
	// IMG_MSG 图片消息
	IMG_MSG MessageType = "image"
	// REVOKE_MSG 撤回消息
	REVOKE_MSG MessageType = "revoke"
	// AGREE_MSG 同意消息
	AGREE_MSG MessageType = "agree"
	// DISAGREE_MSG 不同意消息
	DISAGREE_MSG MessageType = "disagree"
	// VOICE_MSG 语音消息
	VOICE_MSG MessageType = "voice"
	// VIDEO_MSG 视频消息
	VIDEO_MSG MessageType = "video"
	// CARD_MSG 名片消息
	CARD_MSG MessageType = "card"
	// LOC_MSG 位置消息
	LOC_MSG MessageType = "location"
	// EMOTION_MSG 表情消息
	EMOTION_MSG MessageType = "emotion"
	// FILE_MSG 文件消息
	FILE_MSG MessageType = "file"
	// LINK_MSG 链接消息
	LINK_MSG MessageType = "link"
	// WEAPP_MSG 小程序消息
	WEAPP_MSG MessageType = "weapp"
	// CHATRECORD_MSG 话记录消息
	CHATRECORD_MSG MessageType = "chatrecord"
	// TODO_MSG 待办消息
	TODO_MSG MessageType = "todo"
	// VOTE_MSG 投票消息
	VOTE_MSG MessageType = "vote"
	// COLLECT_MSG 填表消息
	COLLECT_MSG MessageType = "collect"
	// REDPACKET_MSG 红包消息
	REDPACKET_MSG MessageType = "redpacket"
	// MEETING_MSG 会议邀请消息
	MEETING_MSG MessageType = "meeting"
	// DOC_MSG 在线文档消息
	DOC_MSG MessageType = "docmsg"
	// MARKDOWN_MSG MarkDown格式消息
	MARKDOWN_MSG MessageType = "markdown"
	// NEWS_MSG 图文消息
	NEWS_MSG MessageType = "news"
	// CALENDAR_MSG 日程消息
	CALENDAR_MSG MessageType = "calendar"
	// MIXED_MSG 混合消息
	MIXED_MSG MessageType = "mixed"
	// MEETING_VOICE_CALL_MSG 音频存档消息
	MEETING_VOICE_CALL_MSG MessageType = "meeting_voice_call"
	// VOIP_DOC_SHARE_MSG 音频共享文档
	VOIP_DOC_SHARE_MSG MessageType = "voip_doc_share"
	// EXTERNAL_REDPACKET_MSG 红包消息
	EXTERNAL_REDPACKET_MSG MessageType = "external_redpacket"
	// SPHFEED_MSG 视频号消息
	SPHFEED_MSG MessageType = "sphfeed"
)

type MixedMessage 

type MixedMessage struct {
	BaseMessage
	// Mixed 消息内容。可包含图片、文字、表情等多种消息。Object类型
	Mixed struct {
		Item []MixedMsg `json:"item,omitempty"`
	} `json:"mixed,omitempty"`
}

MixedMessage 混合消息

type MixedMsg 

type MixedMsg struct {
	Type MessageType `json:"type,omitempty"`
	// Content 消息内容。Json串，内容为对应类型的json
	Content string `json:"content,omitempty"`
}

MixedMsg 混合消息内容

type News 

type News struct {
	// Title 图文消息标题
	Title string `json:"title,omitempty"`
	// Desc 图文消息描述
	Desc string `json:"description,omitempty"`
	// Url 图文消息点击跳转地址
	Url string `json:"url,omitempty"`
	// PicUrl 图文消息配图的url
	PicUrl string `json:"picurl,omitempty"`
}

News 图文消息图文内容

type NewsMessage 

type NewsMessage struct {
	BaseMessage
	// Info 图文消息的内容
	Info struct {
		// Item 图文消息数组
		Item []News `json:"item,omitempty"`
	} `json:"info,omitempty"`
}

NewsMessage 图文消息

type RedpacketMessage 

type RedpacketMessage struct {
	BaseMessage
	// Type 红包消息类型。1 普通红包、2 拼手气群红包、3 激励群红包。
	Type RedpacketType `json:"type,omitempty"`
	// Wish 红包祝福语
	Wish string `json:"wish,omitempty"`
	// TotalCnt 红包总个数
	TotalCnt int `json:"totalcnt,omitempty"`
	// TotalAmount 红包总金额。单位为分。
	TotalAmount int64 `json:"totalamount,omitempty"`
}

RedpacketMessage 红包消息

type RedpacketType 

type RedpacketType = uint32

RedpacketType 红包类型 

const (
	// NORMAL_REDPACKET 普通红包
	NORMAL_REDPACKET RedpacketType = 1
	// SPELL_REDPACKET 拼手气群红包
	SPELL_REDPACKET RedpacketType = 2
	// INCENTIVE_REDPACKET 励群红包
	INCENTIVE_REDPACKET RedpacketType = 3
)

type RevokeMessage 

type RevokeMessage struct {
	BaseMessage
	// PreMsgId 标识撤回的原消息的msgid
	PreMsgId string `json:"pre_msgid,omitempty"`
}

RevokeMessage 撤回消息

type ShareScreenData 

type ShareScreenData struct {
	// Share 屏幕共享用户的id
	Share string `json:"share,omitempty"`
	// ShareTime 屏幕共享开始时间
	StartTime int64 `json:"starttime,omitempty"`
	// EndTime 屏幕共享结束时间
	EndTime int64 `json:"endtime,omitempty"`
}

ShareScreenData 屏幕共享对象

type SphfeedMessage 

type SphfeedMessage struct {
	BaseMessage
	// FeedType 视频号消息类型
	FeedType SphfeedType `json:"feed_type,omitempty"`
	// SphName 视频号账号名称
	SphName string `json:"sph_name,omitempty"`
	// FeedDesc 视频号消息描述
	FeedDesc string `json:"feed_desc,omitempty"`
}

SphfeedMessage 视频号消息

type SphfeedType 

type SphfeedType = uint32

SphfeedType 视频号消息类型 

const (
	// SPHFEED_IMAGE 图片
	SPHFEED_IMAGE SphfeedType = 2
	// SPHFEED_VIDEO 视频
	SPHFEED_VIDEO SphfeedType = 4
	// SPHFEED_LIVE 直播
	SPHFEED_LIVE SphfeedType = 9
)

type SwitchMessage 

type SwitchMessage struct {
	// MsgId 消息id，消息的唯一标识，企业可以使用此字段进行消息去重
	MsgId string `json:"msgid,omitempty"`
	// Action 消息动作，切换企业为switch
	Action string `json:"action,omitempty"`
	// Time 消息发送时间戳，utc时间，ms单位。
	Time int64 `json:"time,omitempty"`
	// User 具体为切换企业的成员的userid。
	User string `json:"user,omitempty"`
}

SwitchMessage 切换企业日志

func (SwitchMessage) ActionType 

func (m SwitchMessage) ActionType() ActionType

ActionType implement ActionType interface

func (SwitchMessage) ID 

func (m SwitchMessage) ID() string

ID implement Message interface

func (SwitchMessage) MessageType 

func (m SwitchMessage) MessageType() MessageType

MessageType implement Message interface

type TextMessage 

type TextMessage struct {
	BaseMessage
	// Content 消息内容。
	Content string `json:"content,omitempty"`
}

TextMessage 文字消息

type TodoMessage 

type TodoMessage struct {
	BaseMessage
	// Title 待办的来源文本
	Title string `json:"title,omitempty"`
	// Content 待办的具体内容
	Content string `json:"content,omitempty"`
}

TodoMessage 待办事项消息

type VideoMessage 

type VideoMessage struct {
	BaseMessage
	// SdkFileId 媒体资源的id信息。
	SdkFileId string `json:"sdkfileid,omitempty"`
	// FileSize 图片资源的文件大小。
	FileSize uint32 `json:"filesize,omitempty"`
	// PlayLength 播放长度。
	PlayLength uint32 `json:"play_length,omitempty"`
	// Md5Sum 图片资源的md5值，供进行校验。
	Md5Sum string `json:"md5sum,omitempty"`
}

VideoMessage 视频消息

type VoiceMessage 

type VoiceMessage struct {
	BaseMessage
	// SdkFileId 媒体资源的id信息。
	SdkFileId string `json:"sdkfileid,omitempty"`
	// VoiceSize 语音消息大小。
	VoiceSize uint32 `json:"voice_size,omitempty"`
	// PlayLength 播放长度。
	PlayLength uint32 `json:"play_length,omitempty"`
	// Md5Sum 图片资源的md5值，供进行校验。
	Md5Sum string `json:"md5sum,omitempty"`
}

VoiceMessage 语音消息

type VoipDocShare 

type VoipDocShare struct {
	// FileName 文档共享文件名称
	FileName string `json:"filename,omitempty"`
	// Md5Sum 共享文件的md5值
	Md5Sum string `json:"md5sum,omitempty"`
	// FileSize 共享文件的大小
	FileSize int64 `json:"filesize,omitempty"`
	// SdkFileId 共享文件的sdkfile，通过此字段进行媒体数据下载
	SdkFileId string `json:"sdkfileid,omitempty"`
}

VoipDocShare 共享文档消息内容

type VoipDocShareMessage 

type VoipDocShareMessage struct {
	BaseMessage
	// VoipId 音频id
	VoipId string `json:"voipid,omitempty"`
	// VoipDocShare 共享文档消息内容。包括filename、md5sum、filesize、sdkfileid字段。Object类型
	VoipDocShare *VoipDocShare `json:"voip_doc_share,omitempty"`
}

VoipDocShareMessage 音频共享文档消息

type VoteMessage 

type VoteMessage struct {
	BaseMessage
	// VoteTitle 投票主题。
	VoteTitle string `json:"votetitle,omitempty"`
	// VoteItem 投票选项，可能多个内容。
	VoteItem []string `json:"voteitem,omitempty"`
	// VoteType 投票类型.101发起投票、102参与投票。
	VoteType VoteType `json:"votetype,omitempty"`
	// VoteId 投票id，方便将参与投票消息与发起投票消息进行前后对照。
	VoteId string `json:"voteid,omitempty"`
}

VoteMessage 投票消息

type VoteType 

type VoteType = uint32

VoteType 投票类型 

const (
	// LAUNCH_VOTE 发起投票
	LAUNCH_VOTE VoteType = 101
	// JOIN_VOTE 参与投票
	JOIN_VOTE VoteType = 102
)

type WeappMessage 

type WeappMessage struct {
	BaseMessage
	// Title  消息标题。
	Title string `json:"title,omitempty"`
	// Desc 消息描述。
	Desc string `json:"description,omitempty"`
	// Username 用户名称。
	Username string `json:"username,omitempty"`
	// DisplayName 小程序名称
	DisplayName string `json:"displayname,omitempty"`
}

WeappMessage 小程序消息

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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