文档中心

数据结构

最近更新时间：2023.12.22 16:55:13

首次发布时间：2023.04.24 11:11:45

返回参数

BaseResponse

参数名	类型	描述
ResponseMetadata	ResponseMetadata
Result	interface{}	仅在请求成功时返回, 具体值参考每个 API 的说明。

ResponseMetadata

参数名	类型	示例值	描述
RequestId	String	`Your_RequestId`	请求标识
Action	String	`BatchAddConversationParticipant`	接口名称
Version	String	`2020-12-01`	接口版本
Service	String	`rtc`	接口所属服务
Region	String	`cn-north-1`	地域参数：`cn-north-1` (华北)
Error	ErrorInfo	无	仅在请求失败时返回。

ErrorInfo

错误的结构定义。

参数名称	类型	描述
CodeN	uint32	网关的错误码
Code	String	API 的错误码，参看错误码。
Message	String	具体的错误信息

群成员相关

Participant

参数名	类型	示例值	描述
ConversationShortId	Int	`000001`	会话 ID
ParticipantUserId	Int	`10001`	群成员 ID
Level	Int	`0`	成员等级
NickName	String	`Your_NickName`	成员昵称
Role	Int	`0`	成员身份。 `0`：普通成员。 `1`：群主。 `2`：群管理员。
Ext	map-key(string)-value(string)	`{"key":"value"}`	成员的扩展字段
Status	Int	`0`	成员状态。 `0`：正常 `1`：退出
Operator	Int	`000010`	操作人对应的 UserId
CreateTime	Int	`1669694619`	成员进群时间对应时间戳，单位为秒
BlockTime	Int	`0`	禁言时间戳，单位为秒。`0`表示不禁言
AvatarUrl	String	`Your_AvatarUrl`	群成员头像

BlockParticipant

参数名	类型	示例值	描述
ParticipantUserId	Int	`10001`	群成员 ID
CreateTime	Int	`1669694619`	禁言/拉黑设置对应的时间戳，单位为秒
BlockTime	Int	`0`	禁言/拉黑到何时对应时间戳，单位为秒
NickName	Int	`xxxx`	禁言/拉黑成员昵称
Ext	map-key(string)-value(string)	`{"key":"value"}`	禁言/拉黑成员扩展字段
AvatarUrl	String	`https://xxxx.com`	禁言/拉黑成员头像

群相关

ConversationInfo

参数名	类型	示例值	描述
AppId	Int	`000000`	应用的唯一标志
ConversationShortId	Int	`000001`	会话 ID
ConversationType	Int	`1`	会话类型。 `1`：单聊 `2`：群聊
InboxType	Int	`0`	信箱，用于逻辑隔离
Name	String	`Conversation`	群名
AvatarUrl	String	`http://xxx.com`	群头像 url
Description	String	`Your_Description`	群描述
OwnerUserId	Int	`100001`	群主 UserId
CreatorUserId	Int	`100001`	创群人 UserId
Notice	String	`Your_Notice`	群公告
Status	Int	`0`	会话状态。 `0`：正常 `1`：已解散
Ext	map-key(string)-value(string)	`{"key":"value"}`	会话的扩展字段。
CreateTime	Int	`1666598278`	群聊创建时间戳，单位为秒
ModifyTime	Int	`1666598278`	修改时间戳，单位为秒
MemberCount	Int	`2`	会话成员数
OnlineCount	Int	`2`	直播群在线人数。
OtherUserId	Int	`10002`	群聊时为会话 ID，单聊时为另一个成员的 UserId

ConversationSettingInfo

参数名	类型	示例值	描述
AppId	Int	`000000`	应用的唯一标志
ConversationShortId	Int	`000001`	会话 ID
ConversationType	Int	`1`	会话类型。 `1`：单聊 `2`：群聊
InboxType	Int	`0`	信箱，用于逻辑隔离
ParticipantUserId	Int	`10001`	群成员 UserId
IsStickTop	Bool	`true`	是否置顶。 `true`：置顶。 `false`：不置顶
IsSetFavorite	Bool	`true`	是否收藏。 `true`：收藏。 `false`：不收藏
IsMute	bool	`true`	是否开启免打扰。 `true`：开启。 `false`：不开启
StickTopTime	Int	`1666495802476129`	置顶时间，单位为毫秒。`0`表示未置顶
SetFavoriteTime	Int	`1666495802476129`	收藏时间，单位为毫秒。 `0`表示未收藏
Ext	map-key(string)-value(string)	`"key":"value"`	扩展字段
ReadIndex	Int	`0`	用户已读位置

消息相关

MessageBody

参数名	类型	示例值	描述
AppId	Int	`000000`	应用的唯一标志
Sender	Int	`000010`	消息发送人 UserId
ConversationShortId	Int	`000001`	会话 ID
ConversationType	Int	`1`	会话类型 `1`：单聊。 `2`：群聊。
MessageId	Int	`000012`	消息 ID
MsgType	Int	`10001`	消息类型。 `10001`：文本。 `10003`：图片。 `10004`：视频 `10005`：文件 `10006`：音频 `10012`：自定义消息
Content	String	`Your_Content`	消息内容
Ext	map-key(string)-value(string)	`{"key":"value"}`	消息的扩展字段
Status	Int	`0`	消息状态，取值为`0`，表示消息可见。
IndexInConversation	Int	`1666495802476129`	消息在会话中的位置
ClientMsgId	String	`"unique-key"`	幂等id，如果创建时指定了此字段，并且数据库中存在此 id 对应的消息，不会重复发送。如果不指定，会随机生成一个。
RefMsgInfo	RefMsgInfo	/	引用消息
CreateTime	Int	`1666613688658`	消息创建时间戳，单位为毫秒
Property	map-key(string)-value([]PropertyItem)	/	修改后的消息属性

PropertyItem

参数名	类型	示例值	描述
Operator	Int	`100001`	操作人 UserId
CreateTime	Int	`1666598278`	操作时间，单位为秒
IdempotentId	String	`Your_IdempotentId`	PropertyItem 唯一标识
Value	String	`Your_Value`	PropertyItem 内容

RefMsgInfo

参数名	类型	示例值	描述
ReferencedMessageId	Int	`10005`	被引用的消息 ID
ReferencedMessageType	Int	`10001`	被引用的消息类型 `10001`：文本。 `10003`：图片。 `10004`：视频 `10005`：文件 `10006`：音频 `10012`：自定义消息
Status	Int	`0`	被引用的消息状态 `0`：消息可见 `1`：消息已过期 `2`：消息（对用户）不可见 `3`：消息被撤回 `4`：消息本身可见，后因删除不可见
Hint	String	`[图片]`	消息引用时展示的文本内容

返回参数

BaseResponse

ResponseMetadata

群成员相关

Participant

BlockParticipant

群相关

ConversationInfo

ConversationSettingInfo

消息相关

MessageBody

RefMsgInfo