聆客开放平台
从Link同步用户到第三方应用
同步第三方用户到Link
加入黑名单
移除黑名单
获取当前用户黑名单
更新用户状态
批量更新用户状态
解绑用户设备

# 从Link同步用户到第三方应用

GET /v1/users/sync

应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。参数不传或传Null表示不修改，传空字符串表示改为null。 参见接入事项-应用身份认证接口

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
cursor integer N query 最后修改时间
limit integer N query 数量
type integer N query 类型

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfListOfUserSyncResult 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/users/sync?cursor={cursor}&limit={limit}&type={type}

# 返回示例

Content-Type: */*

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

PUT /v1/users/sync

企业应用身份：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。
域应用身份：注册应用，联系管理员配置应用id绑定企业域。

参数不传或传Null表示不修改，传空字符串表示改为null。

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
users UserSyncParam[ ] Y body 用户列表
indicated-e-code string N header 域权限应用身份请求，需要设置企业编码

# 返回结果

状态码 说明 返回值 响应头
200 OK ApiResultOfListOfSyncFailLog 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

PUT /v1/users/sync
Content-Type: application/json

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

# 返回示例

Content-Type: */*

{
  "data" : [ {                  //请求返回的数据
    "id" : "string",            //同步方的ID
    "message" : "string"        //失败原因
  } ],
  "code" : "integer",           //结果码 200:成功
  "message" : "string"          //当状态码不是200时，错误信息
}

# 加入黑名单

POST /v1/users/blacklist

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
blackUserId string Y query 拉黑用户ID

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/users/blacklist?blackUserId={blackUserId}
Content-Type: application/json

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 移除黑名单

POST /v1/users/blacklist/remove

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
blackUserId string Y query 拉黑用户ID

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/users/blacklist/remove?blackUserId={blackUserId}
Content-Type: application/json

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 获取当前用户黑名单

GET /v1/users/blacklists

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
limit integer N query 分页大小（为空则返回全部）
offset integer N query 分页偏移量

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultPageOfUamUserBlacklistResult 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/users/blacklists?limit={limit}&offset={offset}

# 返回示例

Content-Type: application/json

{
  "data" : [ {                  //请求返回的数据
    "orgName" : "string",       //用户所属部门名称
    "name" : "string",          //用户名称
    "userId" : "string",        //用户ID
    "picture" : "string",       //用户头像
    "orgId" : "string"          //用户所属部门
  } ],
  "total" : "integer",          //数据总数
  "code" : "integer",           //结果码 200:成功
  "count" : "integer",          //请求返回的数据总数
  "message" : "string"          //当状态码不是200时，错误信息
}

# 更新用户状态

GET /v1/users/{userId}/status/update

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
code string N query 工作状态code
userId string Y path 用户id

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResult 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

GET /v1/users/{userId}/status/update?code={code}

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 批量更新用户状态

POST /v1/users/status/update

应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。

# 请求类型（Content-Type）

  • application/json

# 请求参数

参数名 数据类型 必填 参数位置 参数说明
userStatusParams UserStatusParam[ ] Y body 批量用户状态

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /v1/users/status/update
Content-Type: application/json

[
    {
      "code" : "string",         //用户状态code (01：请假中，不传或者传null对应员工工作状态将会置空)
      "userId" : "string"        //同步方的用户ID
    }
]

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "data" : "object",          //请求返回的数据
  "message" : "string"        //当状态码不是200时，错误信息
}

# 解绑用户设备

POST /open/v1/devices/unbind

应用接口：需在网关上注册应用，注册时必须填写所属eCode，以应用的身份调用。

# 请求类型（Content-Type）

  • application/json

# 请求参数

状态码 说明 返回值 响应头
userStatusParams UnBindDeviceParam[ ] Y body

# 返回结果

状态码 说明 返回值 响应头
200 成功响应 ApiResultOfobject 无
201 Created 无 无
401 Unauthorized 无 无
403 Forbidden 无 无
404 Not Found 无 无

# 请求示例

POST /open/v1/devices/unbind
Content-Type: application/json

{
  "id": "用户id",                    //用户id
  "idType": 1,                      //用户id类型（1:link用户id，2:账号id, 3:源用户id），默认为link用户id
  "deviceId": "设备id",              //需要解绑的设备id（不传，表示解绑用户所有已绑定的设备）
  "reason": 0                       //解绑原因(0:普通解绑，1:单设备登陆，2:修改密码)
}

# 返回示例

Content-Type: application/json

{
  "code" : "integer",         //结果码 200:成功
  "message" : "设置成功"        //当状态码不是200时，错误信息
}

← 部门接口定义 →