You need to enable JavaScript to run this app.
导航
数据结构
最近更新时间:2023.12.22 16:55:13首次发布时间:2023.04.24 11:11:45

返回参数

BaseResponse

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

ResponseMetadata

参数名类型示例值描述
RequestIdStringYour_RequestId请求标识
ActionStringBatchAddConversationParticipant接口名称
VersionString2020-12-01接口版本
ServiceStringrtc接口所属服务
RegionStringcn-north-1地域参数:cn-north-1 (华北)
ErrorErrorInfo仅在请求失败时返回。

ErrorInfo

错误的结构定义。

参数名称类型描述
CodeNuint32网关的错误码
CodeStringAPI 的错误码,参看错误码
MessageString具体的错误信息

群成员相关

Participant

参数名类型示例值描述
ConversationShortIdInt000001会话 ID
ParticipantUserIdInt10001群成员 ID
LevelInt0成员等级
NickNameStringYour_NickName成员昵称
RoleInt0成员身份。
  • 0:普通成员。
  • 1:群主。
  • 2:群管理员。
Extmap-key(string)-value(string){"key":"value"}成员的扩展字段
StatusInt0 成员状态。
  • 0:正常
  • 1:退出
OperatorInt000010操作人对应的 UserId
CreateTimeInt1669694619成员进群时间对应时间戳,单位为秒
BlockTimeInt0禁言时间戳,单位为秒。0表示不禁言
AvatarUrlStringYour_AvatarUrl群成员头像

BlockParticipant

参数名类型示例值描述
ParticipantUserIdInt10001群成员 ID
CreateTimeInt1669694619禁言/拉黑设置对应的时间戳,单位为秒
BlockTimeInt0禁言/拉黑到何时对应时间戳,单位为秒
NickNameIntxxxx禁言/拉黑成员昵称
Extmap-key(string)-value(string){"key":"value"}禁言/拉黑成员扩展字段
AvatarUrlStringhttps://xxxx.com禁言/拉黑成员头像

群相关

ConversationInfo

参数名类型示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
ConversationTypeInt1会话类型。
  • 1:单聊
  • 2:群聊
InboxTypeInt0信箱,用于逻辑隔离
NameStringConversation群名
AvatarUrlStringhttp://xxx.com群头像 url
DescriptionStringYour_Description群描述
OwnerUserIdInt100001群主 UserId
CreatorUserIdInt100001创群人 UserId
NoticeStringYour_Notice群公告
StatusInt0会话状态。
  • 0:正常
  • 1:已解散
Extmap-key(string)-value(string){"key":"value"}会话的扩展字段。
CreateTimeInt1666598278群聊创建时间戳,单位为秒
ModifyTimeInt1666598278修改时间戳,单位为秒
MemberCountInt2会话成员数
OnlineCountInt2直播群在线人数。
OtherUserIdInt10002群聊时为会话 ID,单聊时为另一个成员的 UserId

ConversationSettingInfo

参数名类型示例值描述
AppIdInt000000应用的唯一标志
ConversationShortIdInt000001会话 ID
ConversationTypeInt1会话类型。
  • 1:单聊
  • 2:群聊
InboxTypeInt0信箱,用于逻辑隔离
ParticipantUserIdInt10001群成员 UserId
IsStickTopBooltrue是否置顶。
  • true:置顶。
  • false:不置顶
IsSetFavoriteBooltrue是否收藏。
  • true:收藏。
  • false:不收藏
IsMutebooltrue是否开启免打扰。
  • true:开启。
  • false:不开启
StickTopTimeInt1666495802476129置顶时间,单位为毫秒。0表示未置顶
SetFavoriteTimeInt1666495802476129收藏时间,单位为毫秒。 0表示未收藏
Extmap-key(string)-value(string)"key":"value"扩展字段
ReadIndexInt0用户已读位置

消息相关

MessageBody

参数名类型示例值描述
AppIdInt000000应用的唯一标志
SenderInt000010消息发送人 UserId
ConversationShortIdInt000001会话 ID
ConversationTypeInt1会话类型
  • 1:单聊。
  • 2:群聊。
MessageIdInt000012消息 ID
MsgTypeInt10001消息类型。
  • 10001:文本。
  • 10003:图片。
  • 10004:视频
  • 10005:文件
  • 10006:音频
  • 10012:自定义消息
ContentStringYour_Content消息内容
Extmap-key(string)-value(string){"key":"value"}消息的扩展字段
StatusInt0消息状态,取值为0,表示消息可见。
IndexInConversationInt1666495802476129消息在会话中的位置
ClientMsgIdString"unique-key"幂等id,如果创建时指定了此字段,并且数据库中存在此 id 对应的消息,不会重复发送。如果不指定,会随机生成一个。
RefMsgInfoRefMsgInfo/引用消息
CreateTimeInt1666613688658消息创建时间戳,单位为毫秒
Propertymap-key(string)-value([]PropertyItem)/修改后的消息属性

PropertyItem

参数名类型示例值描述
OperatorInt100001操作人 UserId
CreateTimeInt1666598278操作时间,单位为秒
IdempotentIdStringYour_IdempotentIdPropertyItem 唯一标识
ValueStringYour_ValuePropertyItem 内容

RefMsgInfo

参数名类型示例值描述
ReferencedMessageIdInt10005被引用的消息 ID
ReferencedMessageTypeInt10001被引用的消息类型
  • 10001:文本。
  • 10003:图片。
  • 10004:视频
  • 10005:文件
  • 10006:音频
  • 10012:自定义消息
StatusInt0被引用的消息状态
  • 0:消息可见
  • 1:消息已过期
  • 2:消息(对用户)不可见
  • 3:消息被撤回
  • 4:消息本身可见,后因删除不可见
HintString[图片] 消息引用时展示的文本内容