# 认证接口详情
# 2.4.1 获取校验码接口
JS接口,使用cordova框架调用。服务号平台系统前端内嵌在客户端浏览器中,通过JS脚本调用获取校验码。
提供方:U聊客户端
发起方:接入系统页面JS
调用方式:JS
请求格式:参考JS调用案例
请求编码:UTF-8
请求参数:参考JS调用案例
应答格式:application/json;charset=UTF-8
应答编码:UTF-8
应答数据:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg ecurity 校验码
# 2.4.2 校验码验证接口
核对校验码是否是服务器颁发的,是否有效。
提供方:U聊服务端
发起方:接入系统
# 请求地址:
| /upchat-public-gateway/api/app/checksecurity |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数:
| 属性 | 说明 |
|---|---|
| apikey | 消息发送凭据 |
| security | 校验码 |
# 响应:
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 userinfo 用户信息 响应实例:
{
"msg": "成功",
"status": "0",
"sysid": "upchat_team",
"userinfo": {
"empname":"张三",
"uid":"49d5c980527e2693f12d3d4g5h6re788",
"apikey":"",
"gender":"1",
"domain":"unionpay",
"icon":"",
"remark":"云计算中心/企业服务产品团队",
"empcode":"e63e3920d67c4f4d2d7941u25n5n5k43m",
"mobileno":"c0f15e3c32f440140o0or4n2m2k2nd9j",
"namefirst":"Z",
"userid":"zhangsan",
"ecode":"01331231"
}
}
# 2.4.3 获取关注用户列表接口
获取平台关注用户列表。
提供方:U聊服务端
发起方:接入系统
# 请求地址:
| /upchat-public-gateway/api/app/getattentions |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数:
| 属性 | 说明 |
|---|---|
| apikey | 消息发送凭据 |
# 响应:
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 userlist 关注用户列表
# 2.4.4 OpenApp校验码验证接口
核对校验码是否是服务器颁发的,是否有效。
提供方:U聊服务端
发起方:接入系统
# 请求地址:
| /upchat-public-gateway/api/app/checkOpenSecurity |
调用方式:HTTP POST
请求格式:application/x-www-form-urlencoded;charset=utf-8
请求编码:UTF-8
# 请求参数:
| 属性 | 说明 |
|---|---|
| app_id | OpenApp的标识 |
| app_secret | OpenApp消息发送凭据 |
| security | 校验码 |
# 响应:
响应格式:application/json;charset=UTF-8
响应编码:UTF-8
返回值:
属性 说明 status 应答码,0表示成功,非0时异常信息见msg msg 异常信息 userinfo 用户信息,包括uoid-用户OpenApp唯一id,fname-姓氏,gender-性别,1-男,0-女
# 响应范例:
{ "status":"0",
"msg":"成功",
"userinfo":{
"uoid":"uoid-xxxxxxxxxxx",
"fname":"陈",
"gender":"1"
}
}