qcloud-im-callback/type.go at master · BPing/qcloud-im-callback · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
package qcloud_im_callback

//回调命令
//@link https://www.qcloud.com/doc/product/269/1523
type CallbackCommand string

// 客户端平台
type OptPlatform string

// 请求处理的结果，OK表示处理成功，FAIL表示失败。
type ActionStatus string

// 私有群（Private）：适用于较为私密的聊天场景，群组资料不公开，只能通过邀请的方式加入，类似于微信群。
// 公开群（Public）：适用于公开群组，具有较为严格的管理机制、准入机制，类似于QQ群。
// 聊天室（ChatRoom）：群成员可以随意进出，组织较为松散。
// 互动直播聊天室（AVChatRoom）：适用于互动直播场景，管理上与聊天室相似，但群成员人数无上限；支持以游客身份（不登录）接收消息。
type GroupType string

const (
	//-- 单发消息 --
	CallbackBeforeSendMsgCommand = CallbackCommand("C2C.CallbackBeforeSendMsg") // 发消息之前回调
	CallbackAfterSendMsgCommand  = CallbackCommand("C2C.CallbackAfterSendMsg")  // 发消息之后回调

	//-- 群组系统 --
	CallbackBeforeCreateGroupCommand     = CallbackCommand("Group.CallbackBeforeCreateGroup")     // 创建群组之前回调
	CallbackAfterCreateGroupCommand      = CallbackCommand("Group.CallbackAfterCreateGroup")      // 创建群组之后回调
	CallbackBeforeApplyJoinGroupCommand  = CallbackCommand("Group.CallbackBeforeApplyJoinGroup")  // 申请入群之前回调
	CallbackBeforeInviteJoinGroupCommand = CallbackCommand("Group.CallbackBeforeInviteJoinGroup") // 拉人入群之后回调
	CallbackAfterNewMemberJoinCommand    = CallbackCommand("Group.CallbackAfterNewMemberJoin")    // 新成员入群之后回调
	CallbackAfterMemberExitCommand       = CallbackCommand("Group.CallbackAfterMemberExit")       // 群成员离开之后回调
	GroupCallbackBeforeSendMsgCommand    = CallbackCommand("Group.CallbackBeforeSendMsg")         // 群内发言之前回调
	GroupCallbackAfterSendMsgCommand     = CallbackCommand("Group.CallbackAfterSendMsg")          // 群内发言之后回调
	CallbackAfterGroupFullCommand        = CallbackCommand("Group.CallbackAfterGroupFull")        // 群组满员之后回调
	CallbackAfterGroupDestroyedCommand   = CallbackCommand("Group.CallbackAfterGroupDestroyed")   // 群组解散之后回调
	CallbackAfterGroupInfoChangedCommand = CallbackCommand("Group.CallbackAfterGroupInfoChanged") // 群组资料修改之后回调

	//-- 关系链系统 --
	CallbackFriendAddCommand       = CallbackCommand("Sns.CallbackFriendAdd")       // 添加好友之后回调
	CallbackFriendDeleteCommand    = CallbackCommand("Sns.CallbackFriendDelete")    // 删除好友之后回调
	CallbackBlackListAddCommand    = CallbackCommand("Sns.CallbackBlackListAdd")    // 添加黑名单之后回调
	CallbackBlackListDeleteCommand = CallbackCommand("Sns.CallbackBlackListDelete") // 删除黑名单之后回调

	//-- 在线状态 --
	StateChangeCommand = CallbackCommand("State.StateChange") // 状态变更回调

	// 客户端平台
	RestAPIPlatform = OptPlatform("RESTAPI")
	WebPlatform     = OptPlatform("Web")
	AndroidPlatform = OptPlatform("Android")
	IOSPlatform     = OptPlatform("iOS")
	WindowsPlatform = OptPlatform("Windows")
	MacPlatform     = OptPlatform("Mac")
	UnkownPlatform  = OptPlatform("Unkown")

	// 请求处理结果
	OkStatus   = ActionStatus("OK")
	FAILStatus = ActionStatus("FAIL")

	// 群组系统当前提供四种默认群组形态
	PrivateGroupType    = GroupType("Private")
	PublicGroupType     = GroupType("Public")
	ChatRoomGroupType   = GroupType("ChatRoom")
	AVChatRoomGroupType = GroupType("AVChatRoom")
)

// 腾讯云在发起回调时，会在APP提供的URL之后增加如下几个参数：
// @link https://www.qcloud.com/doc/product/269/1522  回调协议
type URLParams struct {

	// APP在云通讯申请的Appid。
	SdkAppid string  `json:"SdkAppid"`

	// 回调命令字。
	CallbackCommand CallbackCommand `json:"CallbackCommand"`

	//固定为：json。对应：contenttype
	ContentType string  `json:"ContentType"`

	// 客户端IP地址
	ClientIP string  `json:"ClientIP"`

	// 客户端平台。对应不同的平台类型，
	// 可能的取值有： RESTAPI（使用REST API发送请求）、
	//              Web（使用Web SDK发送请求）、
	//              Android、
	//              iOS、
	//              Windows、
	//              Mac、
	//              Unkown（使用未知类型的设备发送请求）。
	OptPlatform OptPlatform  `json:"OptPlatform"`
}

func (up *URLParams) Clone() *URLParams {
	new_obj := (*up)
	return &new_obj
}

// 基本应答包字段
type BaseResponse struct {
	// 请求处理的结果，
	// OK表示处理成功，FAIL表示失败。
	ActionStatus ActionStatus

	// 错误码
	ErrorCode int

	//错误信息。
	ErrorInfo string
}

// 基本请求body内容字段
type BaseBody struct {
	CallbackCommand CallbackCommand
}

// body json
//----------------------------------------------------------------------------------------------------------------------

//发单聊消息
type SendMsgBody struct {
	BaseBody
	From_Account string
	To_Account   string
	MsgBody      []struct { // 消息体，参见TIMMessage消息对象
		MsgType    string
		MsgContent map[string]interface{}
	}
}

// 群基础资料
type GroupInfo struct {
	GroupId string
	Type    GroupType
}

// 群聊消息
type GroupSendMsgBody struct {
	SendMsgBody
	GroupInfo
	Operator_Account string //请求的发起者
	Random           string // 随机数
}