开发者中心 - 小鱼易连

1、创建临时用户

POST https://sdk.xylink.com/api/rest/external/v1/enterprise/tempUser/create?enterpriseId=***&signature=***

参数说明：

·请求参数：

参数	是否必须	参数类型	参数位置	说明
enterpriseId	是	String	Query	小鱼分配的企业id
signature	是	String	Query	api请求签名
name	是	String	Body	用户名称
account	是	String	Body	账户手机号说明: 需要企业内唯一
orgCode	是	String	Body	所属部门
expirationTime	否	Long	Body	账号过期时间： · 默认值: 一周 · 说明: 真实值为参数时间当天的最后一秒, 最大时间间隔半年
title	否	String	Body	职务
mailbox	否	String	Body	邮箱 · 说明: 需要符合邮箱格式
initPassword	否	String	Body	初始密码: · 不能超过24位 · 如果设置了初始密码，则首次登录需要修改 · 如果未设置初始密码，则密码为账户后6位 · 如果该企业配置了密码强度规则，则依赖企业密码强度规则
telephone	否	String	Body	座机号码
applicant	否	String	Body	申请人： · 小鱼不做任何业务处理，仅做记录
applicantDepartment	否	String	Body	申请人所属部门： · 小鱼不做任何业务处理，仅做记录

请求body(示例)：

{
    "name": "xy-临时用户-01",
    "account": "18312341234",
    "mailbox": "temp@xylink.com",
    "initPassword": "18312341234-xylink",
    "telephone": "010-12345678",
    "title": "测试",
    "orgCode": "depcode001",
    "applicant": "hahaha",
    "applicantDepartment": "depcode002"
}

响应参数

·响应body参数：

参数	参数类型	说明
userId	Long	创建成功后的用户id

响应结果（示例）

·http状态码 200

请求成功

{
    "userId": 101990562
}

·http状态码 400

部分请求错误场景

请求失败（参数错误）

{
    "developerMessage": "invalid.parameter",
    "userMessage": "invalid.parameter",
    "errorCode": 1001,
    "moreInfo": "http://www.com.ainemo.com/errors/1001"
}

请求失败（account重复）

{
    "developerMessage": "{\"expirationTime\":1703174399999,\"userId\":122559071}",
    "userMessage": "账号已存在",
    "errorCode": 80002,
    "moreInfo": "http://www.com.ainemo.com/errors/80002"
}

请求失败(无效参数expirationTime)

{
    "developerMessage": "",
    "userMessage": "临时账户过期时间不能小于当前时间",
    "errorCode": 400,
    "moreInfo": "http://www.com.ainemo.com/errors/400"
}

2、修改临时用户信息

PUT https://sdk.xylink.com/api/rest/external/v1/enterprise/tempUser/update?enterpriseId=***&signature=***

参数说明：

·请求参数：

参数	是否必须	参数类型	参数位置	说明
enterpriseId	是	String	Query	小鱼分配的企业id
signature	是	是	是	api请求签名
userId	是	Long	Body	用户id
`name`	否	String	Body	用户名称
orgCode	否	String	Body	所属部门
expirationTime	否	Long	Body	账号过期时间： · 默认值: 一周 · 说明: 真实值为参数时间当天的最后一秒, 最大时间间隔半年
title	否	String	Body	职务
mailbox	否	String	Body	邮箱 · 说明: 需要符合邮箱格式
telephone	否	String	Body	座机号码

请求body(示例)：

{
    "userId": 910012345,
    "name": "xy-临时账户-001",
    "mailbox": "temp@xylink.com",
    "telephone": "010-12345678",
    "title": "测试",
    "orgCode": "depcode001"
}

响应结果（示例）

·http状态码 200

请求成功

·http状态码 400

部分请求错误场景

请求失败（参数错误）

{
    "developerMessage": "invalid.parameter",
    "userMessage": "invalid.parameter",
    "errorCode": 1001,
    "moreInfo": "http://www.com.ainemo.com/errors/1001"
}

请求失败（account重复）

{
    "developerMessage": "{\"expirationTime\":1703174399999,\"userId\":122559071}",
    "userMessage": "账号已存在",
    "errorCode": 80002,
    "moreInfo": "http://www.com.ainemo.com/errors/80002"
}

请求失败(无效参数expirationTime)

{
    "developerMessage": "",
    "userMessage": "临时账户过期时间不能小于当前时间",
    "errorCode": 400,
    "moreInfo": "http://www.com.ainemo.com/errors/400"
}

3、根据用户id查询临时用户信息

GET https://sdk.xylink.com/api/rest/external/v1/enterprise/tempUser/findByUserId?enterpriseId=***&userId=***&signature=***

参数说明：

·请求参数：

参数	是否必须	参数类型	参数位置	说明
enterpriseId	是	String	Query	小鱼分配的企业id
signature	是	String	Query	API请求签名
userId	是	Long	Query	用户id

响应参数

·响应body参数：

参数	参数类型	说明
userId	Long	用户id
name	String	用户名
account	String	账户手机号
mailbox	String	邮箱
telephone	String	座机号
title	String	职位
orgCode	String	部门编码
expirationTime	Long	账户过期时间
applicant	String	申请人
applicantDepartment	String	申请人所属部门

响应结果（示例）

·http状态码 200

请求成功

{
    "name": "张建丰",
    "account": "13532225533",
    "mailbox": "zhangjianfeng@yopmail.com",
    "telephone": "010-12345678",
    "title": "测试",
    "orgCode": "depcode53",
    "expirationTime": 1633255412236,
    "applicant": "hahaha",
    "applicantDepartment": "hahahaha",
    "userId": 101990562
}

·http状态码 400

请求失败

{
    "developerMessage": "invalid.parameter",
    "userMessage": "invalid.parameter",
    "errorCode": 1001,
    "moreInfo": "http://www.com.ainemo.com/errors/1001"
}

4、根据用户id删除临时用户

DELETE https://sdk.xylink.com/api/rest/external/v1/enterprise/tempUser/deletebyUserId?enterpriseId=***&userId=***&signature=***

参数说明：

·请求参数：

参数	是否必须	参数类型	参数位置	说明
enterpriseId	是	String	Query	小鱼分配的企业id
signature	是	String	Query	API请求签名
userId	是	Long	Query	用户id

响应结果（示例）

·http状态码 200

请求成功

·http状态码 400

请求失败

{
    "developerMessage": "invalid.parameter",
    "userMessage": "invalid.parameter",
    "errorCode": 1001,
    "moreInfo": "http://www.com.ainemo.com/errors/1001"
}

5、分页查询临时用户

GET https://sdk.xylink.com/api/rest/external/v1/enterprise/tempUser/page?enterpriseId=***&pageIndex=***&pageSize=***&signature=***

参数说明：

·请求参数：

参数	是否必须	参数类型	参数位置	说明
enterpriseId	是	String	Query	小鱼分配的企业id
signature	是	String	Query	API请求签名
pageIndex	否	Integer	Query	分页参数, 当前页 · 最小值0
pageSize	否	Integer	Query	分页参数, 当前页 · 默认值: 10 · 最大值100

响应参数

·响应body参数：

参数	参数类型	说明
page	Integer	页码
pageTotal	Integer	总页数
rowsTotal	Integer	总数量
rows	Integer	当前页数量
userId	Long	用户id
name	String	用户名
account	String	账户手机号
mailbox	String	邮箱
telephone	String	座机号
title	String	职位
orgCode	String	部门编码
expirationTime	Long	账户过期时间
applicant	String	申请人
applicantDepartment	String	申请人所属部门

响应结果（示例）

·http状态码 200

请求成功

{
    "page": 0,
    "pageTotal": 1,
    "rowsTotal": 1,
    "rows": 1,
    "list": [
        {
            "name": "xy-临时用户-001",
            "account": "18712341234",
            "mailbox": "temp@xylink.com",
            "telephone": "010-12345678",
            "title": "测试",
            "orgCode": "depcode001",
            "expirationTime": 1633255412236,
            "applicant": "hahaha",
            "applicantDepartment": "hahahaha",
            "userId": 910012345
        }
    ]
}

·http状态码 400

请求失败

{
    "developerMessage": "invalid.parameter",
    "userMessage": "invalid.parameter",
    "errorCode": 1001,
    "moreInfo": "http://www.com.ainemo.com/errors/1001"
}

2025-11-06 10:22:56

导出PDF文档