syncmsg

package
v0.1.1 Latest Latest
Warning

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

 Go to latest Published: Aug 17, 2021 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BaseMessage 

type BaseMessage struct {
	MsgID              string `json:"msgid"`           // 消息ID
	OpenKFID           string `json:"open_kfid"`       // 客服帐号ID（msgtype为event，该字段不返回）
	ExternalUserID     string `json:"external_userid"` // 客户UserID（msgtype为event，该字段不返回）
	ReceptionistUserID string `json:"servicer_userid"` // 接待客服userID
	SendTime           uint64 `json:"send_time"`       // 消息发送时间
	Origin             uint32 `json:"origin"`          // 消息来源。3-客户回复的消息 4-系统推送的消息 5-客服回复消息
}

BaseMessage 接收消息

type BusinessCard added in v0.0.14 

type BusinessCard struct {
	BaseMessage
	MsgType      string `json:"msgtype"` // 消息类型，此时固定为：business_card
	BusinessCard struct {
		UserID string `json:"userid"` // 名片 userid
	} `json:"business_card"` // 名片消息
}

BusinessCard 名片消息

type EnterSessionEvent 

type EnterSessionEvent struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：event
	Event   struct {
		EventType      string `json:"event_type"`      // 事件类型。此处固定为：enter_session
		OpenKFID       string `json:"open_kfid"`       // 客服账号ID
		ExternalUserID string `json:"external_userid"` // 客户UserID
		Scene          string `json:"scene"`           // 进入会话的场景值，获取客服帐号链接开发者自定义的场景值
		SceneParam     string `json:"scene_param"`     // 进入会话的自定义参数，获取客服帐号链接返回的url，开发者按规范拼接的scene_param参数
	} `json:"event"` // 事件消息
}

EnterSessionEvent 用户进入会话事件

type Event 

type Event struct {
	ToUserName string `json:"to_user_name"` // 微信客服组件ID
	CreateTime int    `json:"create_time"`  // 消息创建时间，unix时间戳
	MsgType    string `json:"msgtype"`      // 消息的类型，此时固定为 event
	Event      string `json:"event"`        // 事件的类型，此时固定为 kf_msg_or_event
	Token      string `json:"token"`        // 调用拉取消息接口时，需要传此token，用于校验请求的合法性
}

type EventMessage 

type EventMessage struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：event
	Event   struct {
		EventType string `json:"event_type"` // 事件类型
	} `json:"event"` // 事件消息
}

EventMessage 事件消息

type File 

type File struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：file
	File    struct {
		MediaID string `json:"media_id"` // 文件ID
	} `json:"file"` // 文件消息
}

File 文件消息

type Image 

type Image struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：image
	Image   struct {
		MediaID string `json:"media_id"` // 图片文件ID
	} `json:"image"` // 图片消息
}

Image 图片消息 

type Link struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：link
	Link    struct {
		Title  string `json:"title"`   // 标题
		Desc   string `json:"desc"`    // 描述
		URL    string `json:"url"`     // 点击后跳转的链接
		PicURL string `json:"pic_url"` // 缩略图链接
	} `json:"link"` // 链接消息
}

Link 链接消息

type Location 

type Location struct {
	BaseMessage
	MsgType  string `json:"msgtype"` // 消息类型，此时固定为：location
	Location struct {
		Latitude  float32 `json:"latitude"`  // 纬度
		Longitude float32 `json:"longitude"` // 经度
		Name      string  `json:"name"`      // 位置名
		Address   string  `json:"address"`   // 地址详情说明
	} `json:"location"` // 地理位置消息
}

Location 地理位置消息

type Message 

type Message struct {
	MsgID          string `json:"msgid"`           // 消息ID
	OpenKFID       string `json:"open_kfid"`       // 客服帐号ID（msgtype为event，该字段不返回）
	ExternalUserID string `json:"external_userid"` // 客户UserID（msgtype为event，该字段不返回）
	SendTime       uint64 `json:"send_time"`       // 消息发送时间
	Origin         uint32 `json:"origin"`          // 消息来源。3-微信客户发送的消息 4-系统推送的事件消息 5-接待人员在企业微信客户端发送的消息
	MsgType        string `json:"msgtype"`         // 消息类型
	EventType      string `json:"event_type"`      // 事件类型
	OriginData     []byte `json:"origin_data"`     // 原始数据内容
}

Message 同步的消息内容

func (Message) GetBusinessCardMessage added in v0.0.14 

func (r Message) GetBusinessCardMessage() (info BusinessCard, err error)

GetBusinessCardMessage 获取名片消息

func (Message) GetEnterSessionEvent 

func (r Message) GetEnterSessionEvent() (info EnterSessionEvent, err error)

GetEnterSessionEvent 用户进入会话事件

func (Message) GetFileMessage 

func (r Message) GetFileMessage() (info File, err error)

GetFileMessage 获取文件消息

func (Message) GetImageMessage 

func (r Message) GetImageMessage() (info Image, err error)

GetImageMessage 获取图片消息

func (Message) GetLinkMessage added in v0.0.14 

func (r Message) GetLinkMessage() (info Link, err error)

GetLinkMessage 获取链接消息

func (Message) GetLocationMessage 

func (r Message) GetLocationMessage() (info Location, err error)

GetLocationMessage 获取文件消息

func (Message) GetMiniProgramMessage added in v0.0.14 

func (r Message) GetMiniProgramMessage() (info MiniProgram, err error)

GetMiniProgramMessage 获取小程序消息

func (Message) GetMsgSendFailEvent 

func (r Message) GetMsgSendFailEvent() (info MsgSendFailEvent, err error)

GetMsgSendFailEvent 消息发送失败事件

func (Message) GetOriginMessage 

func (r Message) GetOriginMessage() (info []byte)

GetOriginMessage 获取原始消息

func (Message) GetReceptionistStatusChangeEvent added in v0.0.18 

func (r Message) GetReceptionistStatusChangeEvent() (info ReceptionistStatusChangeEvent, err error)

GetReceptionistStatusChangeEvent 客服人员接待状态变更事件

func (Message) GetSessionStatusChangeEvent added in v0.0.18 

func (r Message) GetSessionStatusChangeEvent() (info SessionStatusChangeEvent, err error)

GetSessionStatusChangeEvent 会话状态变更事件

func (Message) GetTextMessage 

func (r Message) GetTextMessage() (info Text, err error)

GetTextMessage 获取文本消息

func (Message) GetVideoMessage 

func (r Message) GetVideoMessage() (info Video, err error)

GetVideoMessage 获取视频消息

func (Message) GetVoiceMessage 

func (r Message) GetVoiceMessage() (info Voice, err error)

GetVoiceMessage 获取语音消息

type MiniProgram added in v0.0.14 

type MiniProgram struct {
	BaseMessage
	MsgType     string `json:"msgtype"` // 消息类型，此时固定为：miniprogram
	MiniProgram struct {
		AppID        string `json:"appid"`          // 小程序appid，必须是关联到企业的小程序应用
		Title        string `json:"title"`          // 小程序消息标题，最多64个字节，超过会自动截断
		ThumbMediaID string `json:"thumb_media_id"` // 小程序消息封面的mediaid，封面图建议尺寸为520*416
		PagePath     string `json:"pagepath"`       // 点击消息卡片后进入的小程序页面路径
	} `json:"miniprogram"` // 小程序消息
}

MiniProgram 小程序消息

type MsgSendFailEvent 

type MsgSendFailEvent struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：event
	Event   struct {
		EventType      string `json:"event_type"`      // 事件类型。此处固定为：msg_send_fail
		OpenKFID       string `json:"open_kfid"`       // 客服账号ID
		ExternalUserID string `json:"external_userid"` // 客户UserID
		FailMsgID      string `json:"fail_msgid"`      // 发送失败的消息msgid
		FailType       uint32 `json:"fail_type"`       // 失败类型。0-未知原因 1-客服账号已删除 2-应用已关闭 4-会话已过期，超过48小时 5-会话已关闭 6-超过5条限制 7-未绑定视频号 8-主体未验证 9-未绑定视频号且主体未验证 10-用户拒收
	} `json:"event"` // 事件消息
}

MsgSendFailEvent 消息发送失败事件

type ReceptionistStatusChangeEvent added in v0.0.18 

type ReceptionistStatusChangeEvent struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：event
	Event   struct {
		EventType          string `json:"event_type"`      // 事件类型。此处固定为：servicer_status_change
		ReceptionistUserID string `json:"servicer_userid"` // 客服人员userid
		Status             uint32 `json:"status"`          // 状态类型。1-接待中 2-停止接待
	} `json:"event"`
}

ReceptionistStatusChangeEvent 客服人员接待状态变更事件

type SessionStatusChangeEvent added in v0.0.18 

type SessionStatusChangeEvent struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：event
	Event   struct {
		EventType             string `json:"event_type"`          // 事件类型。此处固定为：session_status_change
		OpenKFID              string `json:"open_kfid"`           // 客服账号ID
		ExternalUserID        string `json:"external_userid"`     // 客户UserID
		ChangeType            uint32 `json:"change_type"`         // 变更类型。1-从接待池接入会话 2-转接会话 3-结束会话
		OldReceptionistUserID string `json:"old_servicer_userid"` // 老的客服人员userid。仅change_type为2和3有值
		NewReceptionistUserID string `json:"new_servicer_userid"` // 新的客服人员userid。仅change_type为1和2有值
	} `json:"event"` // 事件消息
}

SessionStatusChangeEvent 会话状态变更事件

type Text 

type Text struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：text
	Text    struct {
		Content string `json:"content"` // 文本内容
		MenuID  string `json:"menu_id"` // 客户点击菜单消息，触发的回复消息中附带的菜单ID
	} `json:"text"` // 文本消息
}

Text 文本消息

type Video 

type Video struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：video
	Video   struct {
		MediaID string `json:"media_id"` // 文件ID
	} `json:"video"` // 视频消息
}

Video 视频消息

type Voice 

type Voice struct {
	BaseMessage
	MsgType string `json:"msgtype"` // 消息类型，此时固定为：voice
	Voice   struct {
		MediaID string `json:"media_id"` // 语音文件ID
	} `json:"voice"` // 语音消息
}

Voice 语音消息

Source Files

View all Source files

Jump to

Keyboard shortcuts

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