接口认证说明
更新时间:2022-12-28
接口描述
1、直播间登录认证方式使用接口认证时,主要用于集成对接方的用户账号系统进行鉴权
2、验证接口由对接方进行开发,在学员登录时由我方系统将登录信息提交给该接口进行用户身份验证
3、创建直播间时,验证方式选择接口验证并填写接口地址。例:老师端publisher_authtype为0
在publisherpass填写该接口地址
4、对接方提供的接口请使用POST(Form表单,application/x-www-form-urlencoded)
方式用于接收该验证请求,返回值为json
请求方式
POST/Form表单
请求参数
名称 |
类型 |
必填 |
描述 |
roomid |
String |
直播间id |
必须 |
viewername |
String |
登录用户名 |
必须 |
viewertoken |
String |
登录密码 |
必须 |
返回数据
名称 |
类型 |
必填 |
描述 |
result |
String |
是 |
返回状态:'ok'为成功,'fail'为失败。取值说明:如验证成功该字段应返回 'ok',返回其他值均认为验证失败,即不允许登录 |
message |
String |
否 |
描述信息 |
user |
Object |
是 |
用户信息对象 |
user说明
名称 |
类型 |
必填 |
描述 |
id |
String |
是 |
用户ID,用户唯一标识,取值说明:支持数字英文字符及组合,不支持使用特殊字符如('-',':','?','&')等 |
name |
String |
是 |
用户名,用户人员名称显示 |
avatar |
String |
否 |
扩展字段暂未使用 |
返回示例:
{
"result": "ok",
"message": "登录成功",
"user":{
"id": "E6A232B2DEDF69469C33DC5901307461",
"name': "学员A",
"avatar': ""
}
}