模型定义

ApiResultOfDeviceStatusResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	DeviceStatusResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfGroupInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	GroupInfoResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfGroupJoinCodeResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	GroupJoinCodeResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfLabelResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	LabelResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfGroupInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	GroupInfoResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfLabelRelationResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	LabelRelationResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfLabelResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	LabelResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfMapOfstringAndobject

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	MapOfstringAndobject[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfOrganizationInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	OrganizationInfoResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfOrganizationSyncParam

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	OrganizationSyncParam[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfSyncFailLog

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	SyncFailLog[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfUserInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	UserInfoResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfUserSyncResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	UserSyncResult[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfobject

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfListOfstring

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	string[ ]	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfOrgBulletinResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	OrgBulletinResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfOrganizationInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	OrganizationInfoResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfUserInfoResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	UserInfoResult	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfboolean

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	boolean	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfobject

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	object	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultOfstring

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	string	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

ApiResultEnterpriseRegister

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	string	N	企业编码（eCode）
message	string	N	当状态码不是200时，错误信息

ApiResultPageOfOrgAttachedMemberResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
total	integer	N	数据总数
message	string	N	当状态码不是200时，错误信息
count	integer	N	请求返回的数据总数
data	OrgAttachedMemberResult[ ]	N	请求返回的数据

ApiResultPageOflongAndOrgBulletinResult

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
total	integer	N	数据总数
message	string	N	当状态码不是200时，错误信息
count	integer	N	请求返回的数据总数
cursor	integer	N	分页条件指针
data	OrgBulletinResult[ ]	N	请求返回的数据

AttachedMembersParam

添加部门附属成员参数

属性定义

属性名	数据类型	必填	属性说明
userIds	string[ ]	N	附属成员id（数组格式）

BulletinResourceParam

部门公告资源

属性定义

属性名	数据类型	必填	属性说明
name	string	Y	资源名称
type	integer	Y	资源类型（1：图片，2：附件，3：视频，4：音频）
url	string	Y	资源路径(存储服务文件：存储服务id，外部文件：文件访问路径)
thumbnail	string	Y	资源缩略图路径
size	integer	Y	资源大小（byte）
extension	string	Y	资源格式

BulletinResourceResult

部门公告资源

属性定义

属性名	数据类型	必填	属性说明
id	string	Y	资源id
name	string	Y	资源名称
type	integer	Y	资源类型（1：图片，2：附件，3：视频，4：音频）
url	string	Y	资源路径(存储服务文件：存储服务id，外部文件：文件访问路径)
thumbnail	string	Y	资源缩略图路径
size	integer	Y	资源大小（byte）
extension	string	Y	资源格式

CreateGroupParam

创建群组参数

属性定义

属性名	数据类型	必填	属性说明
name	string	N	群组名称
isPublic	boolean	N	是否开放，开放的群组，用户可以申请加入，不开放的群组，只有管理员可以邀请参加，默认：否
users	string[ ]	N	群组成员账号列表
type	integer	N	群组类型，1：内部群组，2：外部群组，3：项目群组
isThirdGroup	boolean	N	是否第三方群组，默认：否

DeviceStatusResult

用户收藏信息

属性定义

属性名	数据类型	必填	属性说明
status	integer	N	设备状态(0:未绑定，1:已绑定，2:已解除绑定，3:禁止设备，4:遗失设备，-1:未知异常状态)
description	string	N	设备状态描述

EmbApiParam

Emb查询接口参数

属性定义

属性名	数据类型	必填	属性说明
method	string	N	方法名
params	[ ]	N	参数

FavoriteParam

用户收藏参数

属性定义

属性名	数据类型	必填	属性说明
itemId	string	Y	收藏资源id
sourceId	string	Y	来源ID
sourceType	integer	Y	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	Y	来源名称
sourceDisplayName	string	Y	来源显示名称
contentType	integer	Y	收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
content	string	Y	收藏内容
keyword	string	N	搜索关键字
syncBlogFavor	boolean	N	是否同步到动态收藏

FavoriteResult

用户收藏信息

属性定义

属性名	数据类型	必填	属性说明
itemId	string	N	收藏资源id
sourceId	string	N	来源ID
sourceType	integer	N	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	N	来源名称
sourceDisplayName	string	N	来源显示名称
contentType	integer	N	收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
content	string	N	收藏内容
createdDate	integer	N	创建时间

ApiResultOfUamFavoriteDetail

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	UamFavoriteDetail	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息

FavoriteLabelParam

用户收藏标签参数

属性定义

属性名	数据类型	必填	属性说明
name	string	Y	标签名称
sourceId	string	Y	来源ID
sourceType	integer	Y	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	Y	来源名称

FavoriteResult

用户收藏信息

属性定义

属性名	数据类型	必填	属性说明
itemId	string	N	收藏资源id
sourceId	string	N	来源ID
sourceType	integer	N	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	N	来源名称
sourceDisplayName	string	N	来源显示名称
contentType	integer	N	收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
content	string	N	收藏内容
createdDate	integer	N	创建时间

FavoriteWithLabelParam

用户收藏带标签参数

属性定义

属性名	数据类型	必填	属性说明
itemId	string	Y	收藏资源id
labelList	string[ ]	Y	标签ID列表
sourceId	string	Y	来源ID
sourceType	integer	Y	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	Y	来源名称
sourceDisplayName	string	Y	来源显示名称
contentType	integer	Y	收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
content	string	Y	收藏内容
keyword	string	N	搜索关键字
syncBlogFavor	boolean	N	是否同步到动态收藏

UamFavoriteDetail

单条收藏详情

属性定义

属性名	数据类型	必填	属性说明
itemId	string	N	收藏资源id
labelList	UamFavoriteLabelBrief[ ]	N	标签列表
sourceId	string	N	来源ID
sourceType	integer	N	来源类型：0：系统，1：用户，2：群组，3：应用，4：部门，5：服务号，6：企业
sourceName	string	N	来源名称
sourceDisplayName	string	N	来源显示名称
contentType	integer	N	收藏类型，1：文字，2：语音，3：图片，4：视频，5：链接，6：文档，7：云盘，8：动态
content	string	N	收藏内容
createdDate	integer	N	创建时间

UamFavoriteLabelBrief

标签简要信息

属性定义

属性名	数据类型	必填	属性说明
id	string	N	标签ID
name	string	N	标签名称
remark	string	N	备注
createdDate	string	N	创建时间

GroupInfoResult

群组基本信息

属性定义

属性名	数据类型	必填	属性说明
groupId	string	N	群组ID
name	string	N	群组名称
icon	string	N	群组图标
eCode	string	N	企业编码
memberCount	string	N	成员总数
memberRole	integer	N	当前用户在群里的角色(2：群主，1：管理员，0：普通成员，-1：不在此群)

GroupJoinCodeResult

群组入群码信息

属性定义

属性名	数据类型	必填	属性说明
code	string	N	入群码
expireDate	string	N	入群码过期时间

LabelRelationResult

标签关联对象

属性定义

属性名	数据类型	必填	属性说明
customId	string	N	对象id
id	string	N	关联id
labelId	string	N	标签id
type	integer	N	标签类型（1、组织标签 2、用户标签）

LabelResult

标签

属性定义

属性名	数据类型	必填	属性说明
id	string	N	标签id
code	string	N	标签code
name	string	N	标签名称
type	integer	N	标签类型（1、部门标签，2、用户标签）
isDeleted	boolean	N	是否删除
orderNo	integer	N	排序
isSystem	boolean	N	是否系统标签

MapOfstringAndobject

{"type":"object","title":"MapOfstringAndobject","additionalProperties":{"type":"object"}}

OrgAttachedMemberResult

部门附属成员

属性定义

属性名	数据类型	必填	属性说明
orgId	string	N	部门ID
userId	string	N	用户ID
name	string	N	用户名称
isEnable	integer	N	用户是否企业
memRole	integer	N	用户在部门的角色

OrgBulletinParam

部门公告参数

属性定义

属性名	数据类型	必填	属性说明
title	string	Y	公告标题
content	string	Y	公告内容
isImportant	boolean	Y	是否是重要公告
resources	BulletinResourceParam[ ]	Y	公告资源

OrgBulletinResult

部门公告

属性定义

属性名	数据类型	必填	属性说明
id	string	Y	公告id
title	string	Y	公告标题
content	string	Y	公告内容
isImportant	boolean	Y	是否是重要公告
orgId	string	Y	部门id
resources	BulletinResourceResult[ ]	Y	公告资源
createdDate	string	Y	创建时间
createdName	string	Y	创建者

OrganizationInfoResult

部门基本信息

属性定义

属性名	数据类型	必填	属性说明
orgId	string	N	部门ID
name	string	N	部门名称
description	string	N	备注
icon	string	N	部门图标
code	string	N	组织编码
icode	string	N	编码的序号
eCode	string	N	企业编码
labels	string	N	部门标签

OrganizationSyncParam

部门同步参数

属性定义

属性名	数据类型	必填	属性说明
deleted	boolean	N
forceReceive	boolean	N
hidden	boolean	N
linkOrgId	string	N	Link内部的部门ID，必须是UUID，不指定则随机生成新的UUID
orgId	string	Y	同步方的部门ID
orgNum	string	N	部门编号
name	string	N	部门名称
fullName	string	N	部门全称
linkParentId	string	N	Link内部的父部门ID
parentId	string	N	同步方的父部门ID
level	integer	N	层级
status	integer	N	状态（1：启用， 0：停用），默认：1
orderNo	integer	N	排序，默认：0
description	string	N	部门描述
telephone	string	N	联系电话
email	string	N	部门邮箱
isDeleted	boolean	N	是否删除，默认：false
enableChat	integer	N	是否允许聊天（1：允许，0：不允许），默认：1
principal	string	N	负责人
fullPathName	string	N	全名称
source	string	N	检测来源
secretLevel	integer	N	用户隐私密级，默认：0
isForceReceive	boolean	N	是否强制接收消息，为true时用户开启部门消息免打扰将无效，默认：false
isHidden	boolean	N	是否隐藏，默认：false

PictureSyncParam

图片同步参数

属性定义

属性名	数据类型	必填	属性说明
type	integer	N	data数据类型（1：图片url，2：gzip压缩并base64编码数据）
data	string	N	图片内容
fileName	string	N	文件全名（带后缀）

SyncFailLog

同步失败记录

属性定义

属性名	数据类型	必填	属性说明
id	string	N	同步方的ID
message	string	N	失败原因

UserInfoResult

用户基本信息

属性定义

属性名	数据类型	必填	属性说明
userId	string	N	用户ID
name	string	N	用户名称
orgId	string	N	用户所属部门
orgName	string	N	用户所属部门名称
picture	string	N	用户头像
type	integer	N	用户类型
eCode	string	N	企业编码
enterprise	string	N	企业名称

UserSyncParam

第三方应用同步用户参数

属性定义

属性名	数据类型	必填	属性说明
linkUserId	string	N	Link内部的用户ID，不指定则随机生成新的UUID
userId	string	Y	同步方的用户ID
userNum	string	N	用户编号
name	string	N	用户名称，新用户必填
fullName	string	N	用户全称
loginId	string	N	用户登录帐号，如果企业配置了帐号后缀，则同步后的登录帐号为“loginId@xxx”
password	string	N	用户登录密码（密文），加密方式：MD5加密后进行base64编码
pictureParam	PictureSyncParam	N	用户头像
deputyOrgIds	string[ ]	N	用户兼部门ID列表（同步方的部门ID）
orgId	string	N	用户主部门ID（同步方的部门ID）
sex	integer	N	用户性别（1：男，2：女），新用户必填
type	integer	N	用户类型，1：普通用户，4：客服，可传自定义类型
email	string	N	邮箱
mobile	string	N	手机号码，如果登录账号不存在，则以手机号码为登录账号（不加后缀），登录账号与手机号码必须至少存在一个
telephone	string	N	工作电话
birthday	string	N	生日
orderNo	integer	N	排序，默认：0
description	string	N	签名
homeTelephone	string	N	家庭电话
postDescription	string	N	岗位
status	integer	N	状态（1：启用， 0：停用），默认：1
isDeleted	boolean	N	是否删除，默认：false
address	string	N	地址
isHidden	boolean	N	是否隐藏，默认：false
secretLevel	integer	N	密级（0：完全公开,1：好友可见，2：保密），默认：0
extendFields	string	N	扩展字段

UserSyncResult

第三方应用获取用户参数

属性定义

属性名	数据类型	必填	属性说明
deleted	boolean	N
hidden	boolean	N
userId	string	N	同步方的用户ID
linkUserId	string	N	Link内部的用户ID
userNum	string	N	用户编号
name	string	N	用户名称，新用户必填
fullName	string	N	用户全称
loginId	string	N	用户登录帐号，如果企业配置了帐号后缀，则同步后的登录帐号为“loginId@xxx”
password	string	N	用户登录密码（密文），加密方式：MD5加密后进行base64编码
picture	string	N	用户头像
linkOrgId	string	N	用户主部门ID（Link内部的部门ID）
orgId	string	N	用户主部门ID（同步方的部门ID）
type	integer	N	用户类型，默认：1（普通用户）
sex	integer	N	用户性别（1：男，2：女）
email	string	N	邮箱
mobile	string	N	手机号码
telephone	string	N	工作电话
birthday	string	N	生日
orderNo	integer	N	排序，默认：0
description	string	N	签名
homeTelephone	string	N	家庭电话
postDescription	string	N	岗位
status	integer	N	状态（1：启用， 0：停用），默认：1
isDeleted	boolean	N	是否删除，默认：false
address	string	N	地址
secretLevel	integer	N	密级（0：完全公开,1：好友可见，2：保密），默认：0
isHidden	boolean	N	是否隐藏，默认：false
extendFields	string	N	扩展字段
lastUpdatedDate	string	N	最后更新时间

UserStatusParam

用户状态更新参数

属性定义

属性名	数据类型	必填	属性说明
userId	string	Y	同步方的用户ID
code	string	Y	用户状态code

EnterpriseRegistrationParam

企业注册参数

属性定义

属性名	数据类型	必填	属性说明
enterpriseName	string	N	企业名称
shortName	string	N	企业简称
contactName	string	N	联系人
contactPhone	string	N	联系电话
enterpriseMail	string	N	企业邮箱
enterpriseAddress	string	N	企业地址
enterpriseIntroduction	string	N	企业简介
enterpriseVersion	string	N	企业版本
isAllowManage	boolean	N	是否允许域管理员或者平台管理员管理企业，默认为true

UnBindDeviceParam

设备解绑参数

属性定义

属性名	数据类型	必填	属性说明
id	string	Y	用户id
idType	integer	N	用户Id类型（1:link用户id，2:账号id, 3:源用户id），默认为link用户id
deviceId	string	N	需要解绑的设备id（不传，表示解绑用户所有已绑定的设备）
reason	integer	N	解绑原因(0:普通解绑，1:单设备登陆，2:修改密码)

ApiResultOfstring

API调用的结果集

属性定义

属性名	数据类型	必填	属性说明
code	integer	Y	结果码 200:成功
data	string	N	请求返回的数据
message	string	N	当状态码不是200时，错误信息