帐号管理
一、创建云会议帐号
简要描述:
- 创建云会议账号接口
请求URL:
https://openapi.quanshi.com/user/account/createAccount
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传递6 |
username | 是 | string | 管理员用户名 |
password | 是 | string | 管理员密码 |
hostUserId | 是 | int | 创建账号依赖的模板用户ID |
account_userName | 是 | string | 新开账号的用户姓名 |
account_userEmail | 是 | string | 电子邮箱 |
account_userPassword | 否 | string | 指定账号密码(非必填),新开账号的预设密码 |
AccountSiteUrl | 否 | string | 站点url |
AccountType | 否 | int | 1:账号(有主持人权限,可以预约会议,会强制开启电话语音的外呼权限)2. 用户(只参加会议) 如果不填写默认创建与HostUserId的是否具有主持人权限一致。 |
account_countryCode | 否 | string | 国家码,传空时默认86 |
account_userMobile | 否 | string | 手机(非必填),新开账号的手机号码 |
account_company | 否 | string | 公司名称(非必填) |
AccountUserTel | 否 | string | 用户联系电话(非必填),新开账号的电话号码 |
language | 否 | string | 帐号语言(中文:zh-cn 英文:en) |
confScale | 否 | int | 会议方数,允许入会的最大人数(非必填,当accountType=1,appId =6时才有效) |
allowHostCall | 否 | int | 是否允许主持人自我外呼(非必填,当accountType=1,appId =6时才有效) 0:不允许主持人自我外呼,1:允许主持人自我外呼(默认) |
allowAttendeeCall | 否 | int | 是否允许参会人自我外呼(非必填,当accountType=1,appId =6时才有效) 0:不允许参会人自我外呼 1:允许参会人自我外呼 (默认) |
callbackUrl | 否 | string | PC3.0账号开通成功的回调地址(账号开通后,以Post方式回调该地址,通知账号可用,空值默认不回调) |
返回示例
{
"status": 0,
"result": {
"userId": 87670835,
"passwd": "PhP5531"
},
"request_id": "confopenapiserver-192.168.22.58-1598340812.762903000.887",
"timestamp": 1598340812762,
"callSeq": "",
"content_type": "application/json",
"request_duration": "3.899501601s"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 成功的结果 |
userId | int | 新创建账号对应的userID |
passwd | string | 新创建账号的登录密码 |
备注
- 更多返回错误代码请看首页的错误代码描述
二、查询创建云会议账号
简要描述:
- 创建云会议账号(查询创建)接口,与创建接口不同的是会先根据输入的参数查询是否已开通,已开通则直接返回
请求URL:
https://openapi.quanshi.com/user/account/createAccountByQuery
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传递6 |
username | 是 | string | 管理员用户名 |
password | 是 | string | 管理员密码 |
hostUserId | 是 | int | 创建账号依赖的模板用户ID |
account_userName | 是 | string | 新开账号的用户姓名 |
account_userEmail | 是 | string | 电子邮箱 |
account_userPassword | 是 | string | 指定账号密码(非必填),新开账号的预设密码 |
AccountSiteUrl | 是 | string | 站点url(必填) |
AccountType | 否 | int | 1:账号(有主持人权限,可以预约会议,会强制开启电话语音的外呼权限)2. 用户(只参加会议) 如果不填写默认创建与HostUserId的是否具有主持人权限一致。 |
account_countryCode | 否 | string | 国家码,传空时默认86 |
account_userMobile | 否 | string | 手机(非必填),新开账号的手机号码 |
account_company | 否 | string | 公司名称(非必填) |
AccountUserTel | 否 | string | 用户联系电话(非必填),新开账号的电话号码 |
language | 否 | string | 帐号语言(中文:zh-cn 英文:en) |
confScale | 否 | int | 会议方数,允许入会的最大人数(非必填,当accountType=1,appId =6时才有效) |
allowHostCall | 否 | string | 是否允许主持人自我外呼(非必填,当accountType=1,appId =6时才有效) 0:不允许主持人自我外呼,1:允许主持人自我外呼(默认) |
allowAttendeeCall | 否 | string | 是否允许参会人自我外呼(非必填,当accountType=1,appId =6时才有效) 0:不允许参会人自我外呼 1:允许参会人自我外呼 (默认) |
callbackUrl | 否 | string | PC3.0账号开通成功的回调地址(账号开通后,以Post方式回调该地址,通知账号可用,空值默认不回调) |
返回示例
{
"status": 0,
"result": {
"userId": 87661457,
"passwd": "fym8103"
},
"content_type": "application\/json"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 成功的结果 |
userId | int | 新创建账号对应的userID |
passwd | string | 新创建账号的登录密码 |
备注
- 更多返回错误代码请看首页的错误代码描述
三、修改云会议帐号
简要描述:
- 修改云会议账号接口
请求URL:
https://openapi.quanshi.com/user/account/updateAccount
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传递6 |
username | 是 | string | 管理员登录名 |
password | 是 | string | 管理员密码 |
account_userId | 是 | int | 要修改的用户userID |
account_userName | 是 | string | 要修改的用户登录名 |
account_userEmail | 是 | string | 要修改的用户电子邮箱 |
account_userMobile | 否 | string | 要修改的用户手机 |
返回示例
{
"status": 0,
"result": null,
"request_id": "confopenapiserver-192.168.28.45-1597740918.776650957.300",
"timestamp": 1597740918776,
"callSeq": "",
"content_type": "application/json",
"request_duration": "409.888137ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
备注
- 更多返回错误代码请看首页的错误代码描述
四、查询云会议帐号
简要描述:
- 查询云会议账号接口
请求URL:
https://openapi.quanshi.com/user/account/searchAccount
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传递6 |
username | 是 | string | 管理员登录名 |
password | 是 | string | 管理员密码 |
account_userEmail | 是 | string | 要查询的用户电子邮箱 |
返回示例
{
"status": 0,
"result": {
"keyPrefix": "",
"uniqueKey": 0,
"id": 87669201,
"loginName": "openpaitest30xx_dtest@testopenapi.com",
"password": "62191af07cd3900f12f8ef8c69a60048",
"passType": 1,
"email": "openpaitest30xx_dtest@testopenapi.com",
"userstatus": 1,
"productStatus": 0,
"sex": 0,
"mobileNumber": "",
"register": true,
"namepinyin": "OPENPAITEST30XX_DTESTX",
"namepinyinFull": "openpaitest30xx_dtestx",
"registertime": 1597740759000,
"lastlogintime": 0,
"userforgetflag": false,
"organizationId": 0,
"organizationName": "",
"orgDetails": [],
"parentOrgName": "",
"oldOrgNodeCode": "",
"orgNodeCode": "",
"position": "",
"displayName": "openpaitest30xx_dtestx",
"first_name": "",
"middle_name": "",
"last_name": "",
"homePage": "",
"iconUrl": "",
"description": "",
"lastUpdateTime": 1598411325000,
"office": "",
"officePhone": "",
"sign": "",
"contactId": 0,
"obj": null,
"cityCode": "",
"countryCode": "86",
"subCode": "",
"phoneTypeName": "",
"mailVerified": true,
"phoneVerified": false,
"invisible": false,
"role": 1,
"userTpList": [],
"userProductList": [{
"id": 0,
"userId": 87669201,
"productId": 80,
"userStatus": 82,
"status": 61,
"sitesId": 171723,
"statusModifyTime": 0,
"createdTime": 1597740760000,
"isHostAccount": null,
"isNoFunds": false
}, {
"id": 0,
"userId": 87669201,
"productId": 60000,
"userStatus": 82,
"status": 61,
"sitesId": 171699,
"statusModifyTime": 0,
"createdTime": 1597740760000,
"isHostAccount": null,
"isNoFunds": false
}],
"otherProperty": [],
"createTime": null,
"passwordUpdateTime": null,
"passwordLevel": 0,
"orderFlag": null,
"nameid": "",
"hostPasscode": "",
"participantPasscode": "",
"sitesId": 0,
"parentOrgId": null,
"openProductStatus": 0,
"customerCode": "153390",
"customerName": "",
"isEnterpriseUser": 0,
"userIdentifications": [],
"invitationCode": "",
"key": "",
"externalUserName": "",
"externalUserAddr": "",
"externalConfigId": null,
"ecologicalUser": false,
"cacheKeyPrefix": "com:quanshi:ums:profile",
"cacheUniqueKey": 87669201,
"name": "",
"password_type": 1
},
"request_id": "confopenapiserver-192.168.22.47-1599468702.717168000.81",
"timestamp": 1599468702717,
"callSeq": "",
"content_type": "application/json",
"request_duration": "1.528253294s"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json | 查询结果 |
id | int | 用户ID |
loginName | string | 用户登录名 |
string | 用户电子邮箱 | |
countryCode | string | 用户手机号国家码 |
mobileNumber | string | 用户手机号 |
displayName | string | 用户姓名 |
userProductList | 数组 | 用户已开通产品列表 |
customerCode | string | 用户所属的客户编码 |
hostPasscode | string | 主持人密码 |
participantPasscode | string | 参会人密码 |
备注
- 更多返回错误代码请看首页的错误代码描述
五、禁用/启用云会议帐号
简要描述:
- 禁用/启用云会议账号接口
请求URL:
https://openapi.quanshi.com/user/account/changeUserStatus
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传递6 |
username | 是 | string | 管理员登录名 |
account_userId | 是 | int | 需要启用/禁用的账号ID |
valid | 是 | int | 操作类型 禁用账号=0,启用账号=1 |
返回示例
{
"status": 0,
"result": null,
"msg": "change user status success",
"request_id": "confopenapiserver-192.168.22.58-1598411318.43160000.887",
"timestamp": 1598411318043,
"callSeq": "",
"content_type": "application/json",
"request_duration": "2.411576593s"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
备注
- 更多返回错误代码请看首页的错误代码描述
六、获取云会议帐号
简要描述:
- 获取云会议账号接口
请求URL:
https://openapi.quanshi.com/user/account/getUserIdsByEmails
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | string | 用户名 |
emails | 是 | string数组 | 电子邮箱数组 |
appKey | 是 | string | 客户唯一标识 |
返回示例
{
"status": 0,
"result": [{
"userId": 81299514,
"email": "ejs3@test1.com"
}, {
"userId": 81299515,
"email": "eyh1@test1.com"
}, {
"userId": 81586150,
"email": "20190918test5@quanshitest.com"
}],
"request_id": "confopenapiserver-192.168.22.58-1598411453.185250000.59",
"timestamp": 1598411453185,
"callSeq": "",
"content_type": "application/json",
"request_duration": "209.955309ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | 数组 | 根据邮箱参数数组查询到的结果数组 |
userId | int | 用户ID |
string | 用户电子邮箱 |
备注
- 更多返回错误代码请看首页的错误代码描述
七、通过邮箱设置密码
简要描述:
- 通过邮箱设置密码接口
请求URL:
https://openapi.quanshi.com/user/account/resetPassword
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
是 | string | 用户电子邮箱 | |
password | 否 | string | 新密码,若不传递则系统自动生成一个随机密码 |
返回示例
{
"status": 0,
"result": {
"password": "yhy123"
},
"request_id": "confopenapiserver-192.168.28.45-1597745244.721618219.847",
"timestamp": 1597745244721,
"callSeq": "",
"content_type": "application/json",
"request_duration": "92.101201ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 成功的返回,返回新设置的密码 |
password | string | 返回新设置的密码 |
备注
- 更多返回错误代码请看首页的错误代码描述
八、获取帐号硬件视频权限开通情况
简要描述:
- 获取账号硬件视频等权限开通情况接口
请求URL:
https://openapi.quanshi.com/conference/conference/getUserCustomerInfo
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID(仅支持6:PC3.0) |
userId | 是 | int | 会议主持人userID |
返回示例
{
"status": 0,
"result": {
"hardwareVideo": 0
},
"msg": "get customer info success",
"request_id": "confopenapiserver-10.90.43.102-1599532521.270405812.211",
"timestamp": 1599532521270,
"callSeq": "",
"content_type": "application/json",
"request_duration": "120.040374ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 返回结果 |
hardwareVideo | int | 0:无硬件视频权限,1:有硬件视频权限 |
备注
- 更多返回错误代码请看首页的错误代码描述
九、获取会议通用属性
简要描述:
- 获取用户配置接口
请求URL:
https://openapi.quanshi.com/conference/conference/getConfig
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传6 |
userId | 是 | int | 账号userID |
返回示例
{
"status": 0,
"result": {
"userId": 4307081,
"emailLanguage": "En-us",
"isFreeJoin": 1,
"confTips": 1,
"allowMobile": 1,
"videoConferenceMode": 1,
"videoControl": 1,
"videoStandardSet": 2,
"relieveMute": 0,
"enableDoc": 1,
"enableWhiteboard": 1,
"shareNotes": 0,
"sharePageTurn": 0,
"watermark": 0,
"saveShare": 0,
"autoRecord": 0,
"showWholeAttendList": 0,
"isFreeChat": 0,
"muteSoundMsg": 1
},
"msg": "getConfConfig success",
"request_id": "confopenapiserver-10.90.43.102-1599532545.848910555.106",
"timestamp": 1599532545848,
"callSeq": "",
"content_type": "application/json",
"request_duration": "29.989512ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | int | 返回结果 |
userId | int | 用户userID |
emailLanguage | string | 用户会议邀请的邮件语言 (En-us:英文,Zh-cn:中文,Zh-cnEn-us:中英文) |
isFreeJoin | int | 参会人提前入会设置 0:主持人入会后方可入会;1:不限(默认) |
confTips | int | 入会退会提示,0:不提示;1:提示,默认1 |
allowMobile | int | 允许手机入会0:禁止参会人手机端入会,1:允许参会人手机端入会(默认) |
videoConferenceMode | int | 视频入会,0:入会不自动开视频(默认),1:入会自动开视频 |
videoControl | int | 视频权限 1:会中由主持人控制,2:参会人会中可自由开关(默认) |
videoStandardSet | int | 视频清晰度 1:标清(默认),2:高清,4:超清 |
relieveMute | int | 解除静音0:仅主持人才能解除(默认),1:允许参会人自己解除 |
enableDoc | int | 共享文档0:不允许共享文档(默认), 1:仅主持人共享文档,2:所有人都可以共享文档 |
enableWhiteboard | int | 共享白板0:不允许共享白板(默认), 1:仅主持人共享白板,2:所有人都可以共享白板 |
shareNotes | int | 共享批注0:不允许参会人批注 1:允许自由批注(默认) |
sharePageTurn | int | 共享翻页 0:不允许参会人翻页 1:允许自由翻页(默认) |
watermark | int | 查看共享桌面0:不加水印(默认) 1:加水印 |
saveShare | int | 保存共享0:不允许保存共享 1:允许保存共享(默认) |
autoRecord | int | 录制0:手动开启录制(默认) 1:入会自动开启录制 |
showWholeAttendList | int | 参会列表0:对参会人隐藏参会列表 1:显示完整参会列表(默认) |
isFreeChat | int | 会中聊天0:仅与主持人聊天,1:允许自由聊天(默认) |
muteSoundMsg | int | 提示语音0:关闭语音提示, 1:开启语音提示(默认) |
备注
- 更多返回错误代码请看首页的错误代码描述
十、修改会议通用属性
简要描述:
- 修改会议通用属性接口
请求URL:
https://openapi.quanshi.com/conference/conference/updateConfig
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | int | 应用ID,请传6 |
userId | 是 | int | 会议主持人用户ID |
isFreeJoin | 否 | int | 参会人提前入会设置 0:主持人入会后方可入会;1:不限(默认) |
allowMobile | 否 | int | 允许手机入会0:禁止参会人手机端入会,1:允许参会人手机端入会(默认) |
videoConferenceMode | 否 | int | 视频入会,0:入会不自动开视频(默认),1:入会自动开视频 |
videoControl | 否 | int | 视频权限 1:会中由主持人控制,2:参会人会中可自由开关(默认) |
videoStandardSet | 否 | int | 视频清晰度 1:标清(默认),2:高清,4:超清 |
relieveMute | 否 | int | 解除静音0:仅主持人才能解除(默认),1:允许参会人自己解除 |
enableDoc | 否 | int | 共享文档0:不允许共享文档(默认), 1:仅主持人共享文档,2:所有人都可以共享文档 |
enableWhiteboard | 否 | int | 共享白板0:不允许共享白板(默认), 1:仅主持人共享白板,2:所有人都可以共享白板 |
shareNotes | 否 | int | 共享批注0:不允许参会人批注 1:允许自由批注(默认) |
sharePageTurn | 否 | int | 共享翻页 0:不允许参会人翻页 1:允许自由翻页(默认) |
watermark | 否 | int | 查看共享桌面0:不加水印(默认) 1:加水印 |
saveShare | 否 | int | 保存共享0:不允许保存共享 1:允许保存共享(默认) |
autoRecord | 否 | int | 录制0:手动开启录制(默认) 1:入会自动开启录制 |
showWholeAttendList | 否 | int | 参会列表0:对参会人隐藏参会列表 1:显示完整参会列表(默认) |
isFreeChat | 否 | int | 会中聊天0:仅与主持人聊天,1:允许自由聊天(默认) |
muteSoundMsg | 否 | int | 提示语音0:关闭语音提示, 1:开启语音提示(默认) |
返回示例
{
"status": 0,
"result": null,
"msg": "updateConfig success",
"request_id": "confopenapiserver-10.90.42.102-1599532693.596926423.728",
"timestamp": 1599532693596,
"callSeq": "",
"content_type": "application/json",
"request_duration": "714.179101ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
备注
- 更多返回错误代码请看首页的错误代码描述
十一、批量获取帐号登录的authKey
简要描述:
- 批量获取authkey接口。
请求URL:
https://openapi.quanshi.com/confopenapi/account/authkey/get
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
loginnames | 否 | []string | 用户登录名数组; 最大成员 50 个;选填 (万科这里默认传参是域账号) |
extLogins | 否 | []object | ad 域用户登录名数组; 最大成员 50 个;选填 |
create | 否 | bool | 是否生成新的 authKey, 选填, 默认:false。true代表新建,false会按照传递的expireTime的值更新authkey的有效期 |
expireTime | 是 | int64 | 过期时间, Unix 时间戳(精确到毫秒). -1, 永久不过期; 必填。 |
extLogins数组中object的参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
extloginname | 否 | string | 用户 ldap 登陆的 name |
siteid | 否 | string | 站点 ID |
请求示例
{
"loginnames": ["20190918test5@quanshitest.com", "wu_923_b_055@qs.com"],
"extLogins": [{
"extloginname": "ad_wy03",
"siteid": "76473"
}],
"create": true,
"expireTime": 1619861074000
}
返回示例
{
"status": 0,
"result": [
{
"userId": 64050819,
"loginname": "ad_wy03@haier.com",
"authKey": "f4265c94-accf-4892-9a61-52ac19418916",
"expireTime": 1619861074000
},
{
"userId": 81586150,
"loginname": "20190918test5@quanshitest.com",
"authKey": "3f9458ba-0b1c-4094-9fc1-e81bffd774ee",
"expireTime": 1619861074000
},
{
"userId": 63675723,
"loginname": "wu_923_b_055@qs.com",
"authKey": "9f117860-f027-454f-baa3-14b5f81be113",
"expireTime": 1619861074000
}
],
"request_id": "confopenapiserver-192.168.0.183-1619592136.557235000.81",
"timestamp": 1619592136557,
"content_type": "application/json",
"request_duration": "200.956369ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json数组 | 返回值 |
request_id | string | 请求唯一标识 |
timestamp | int64 | 服务器时间戳 |
返回result数组内object参数说明
参数名 | 类型 | 说明 |
---|---|---|
userId | uint64 | 账号对应的ums userId |
loginname | string | 账号的登录名 |
authKey | string | 用户 authKey, 如果用户 authKey 不存在, 此字段 为空 |
expireTime | int64 | 用户 authKey 过期时间,Unix 时间戳(毫秒); -1 表示永不 过期。如果用户 authKey 不存在, 此字段为空 |
错误码
返回值 | 说明 |
---|---|
51210 | 从UMS批量获取authkey失败 |
备注
- 更多返回错误代码请看首页的错误代码描述
十二、根据邮箱和手机号批量获取帐号信息接口
简要描述:
- 根据邮箱和手机号批量获取账号信息接口,限制一次查询最多200个邮箱,200个手机号
- 仅返回查询证书所在的客户下的账号
请求URL:
https://openapi.quanshi.com/confopenapi/account/getUsersByEmailsMobiles
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
emails | 否 | []string | 邮箱列表,最大支持200个 |
mobiles | 否 | []string | 手机号列表,最大支持200个 |
传参示例
{
"emails": ["20190918test5@quanshitest.com"],
"mobiles": ["15950095725"]
}
返回示例
{
"status": 0,
"result": {
"15950095725": {
"userId": 63111959,
"loginName": "475229890@qq.com",
"email": "475229890@qq.com",
"countryCode": "86",
"mobile": "15950095725",
"customerCode": "020880",
"companyName": "",
"displayName": "",
"firstName": "",
"middleName": "",
"lastName": "Rock"
},
"20190918test5@quanshitest.com": {
"userId": 81586150,
"loginName": "20190918test5@quanshitest.com",
"email": "20190918test5@quanshitest.com",
"countryCode": "86",
"mobile": "20190918005",
"customerCode": "020880",
"companyName": "",
"displayName": "20190918test5",
"firstName": "",
"middleName": "",
"lastName": "20190918test5"
}
},
"request_id": "confopenapiserver-192.168.0.188-1627277897.307398000.81",
"reqid": "confopenapiserver-192.168.0.188-1627277897.307398000.81",
"timestamp": 1627277897307,
"content_type": "application/json",
"request_duration": "880.744438ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | object | 查询结果,map形式,key为传参中的邮箱或者手机号 |
userId | int | 查询账号对应的用户ID |
loginName | string | 查询账号对应的登录名 |
string | 查询账号对应的邮箱 | |
countryCode | string | 查询账号对应的手机号的国家码 |
customerCode | string | 查询账号对应的客户编码 |
customerCode | string | 查询账号对应的客户编码 |
companyName | string | 查询账号对应的公司名称 |
firstName | string | 查询账号对应的firstName |
middleName | string | 查询账号对应的middleName |
lastName | string | 查询账号对应的lastName |
备注
- 更多返回错误代码请看首页的错误代码描述
十三、根据userId批量获取帐号信息
简要描述:
- 根据UserId批量获取账号信息接口,限制一次查询最多1000个
- 仅返回查询证书所在的客户下的账号
请求URL:
https://openapi.quanshi.com/confopenapi/account/getUsersByIds
请求方式:
- POST
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userIds | 是 | []int | UserId列表,最大支持1000个 |
传参示例
{"userIds":[87679779,88603446]}
返回示例
{
"status": 0,
"result": [
{
"id": 87679779,
"displayName": "分流测试1",
"position": "",
"loginName": "fltest_001@fl.com",
"userstatus": 1,
"email": "fltest_001@fl.com",
"lastName": "分流测试1",
"firstName": "",
"middleName": "",
"mobileNumber": "",
"namepinyin": "FLCS1",
"iconUrl": "http://testbeefs.quanshi.com:80/ucfserver/hddown?fid=ODc2Nzk3NzkvOC88fDo-MTYxNTI3NjYzMTY3NC5wbmdeXl50YW5naGRmc15eXmJhNjA2YzU3NGU5YmI0ZjVhNTQ4MzgwYmZjODNhYjIyXl5edGFuZ2hkZnNeXl40NjI2Nw$&u=87679779",
"sex": 1,
"lastUpdateTime": 1620806580000,
"organizationId": 45244,
"organizationName": "北京山河在线网络科技有限公司",
"countryCode": "",
"customerCode": "002136"
}
],
"request_id": "confopenapiserver-172.10.5.195-1652955025.467980534.81",
"reqid": "confopenapiserver-172.10.5.195-1652955025.467980534.81",
"timestamp": 1652955025468,
"content_type": "application/json",
"product_type": "",
"device_type": "",
"iscycle": "",
"isgnet": "",
"mem_count": "",
"verify": "",
"video_conference_mode": "",
"live_flag": "",
"conferenceid": "",
"record": 0,
"share_media": 0,
"hardware_video": 0,
"accessNumber": "",
"client_ip": "",
"request_duration": "386.821288ms"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | []object | 查询结果,数组 |
id | int | 查询账号对应的用户ID |
loginName | string | 查询账号对应的登录名 |
displayName | string | 查询账号对应姓名 |
string | 查询账号对应的邮箱 | |
countryCode | string | 查询账号对应的手机号的国家码 |
mobileNumber | string | 查询账号对应的手机号 |
organizationId | string | 查询账号对应的组织编码 |
organizationName | string | 查询账号对应的组织名称 |
firstName | string | 查询账号对应的firstName |
middleName | string | 查询账号对应的middleName |
lastName | string | 查询账号对应的lastName |
position | string | 查询账号对应的职位 |
备注
- 更多返回错误代码请看首页的错误代码描述