获取讲师信息

接口描述

1、获取讲师信息
2、接口支持https协议

接口URL

http://api.polyv.net/live/v3/channel/account/getTeacher

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名必选类型说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

channelId

true

String

频道号

示例

http://api.polyv.net/live/v3/channel/account/getTeacher?appId=frlr1zazn3&sign=B9B8F9128AF8EE0E2E25B492C06E5A72&channelId=2205489&timestamp=1680599633136

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

Object

成功返回true,错误返回空.【详见Data字段说明

Data参数描述

参数名类型说明

account

String

讲师id,同频道号

actor

String

讲师头衔

avatar

String

讲师头像,例://liveimages.videocc.net/uploaded/images/2023/04/gjps9etdpx.jpg

channelId

String

频道号

nickname

String

讲师昵称

passwd

String

讲师登录密码

loginCode

String

该字段为null

role

String

该字段为null

Java请求示例

快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChatRoleTest.class);
/**
 * 查询讲师身份信息
 * @throws IOException
 */
@Test
public void testUpdateTeacherInfo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/account/getTeacher";
    String channelId = "2205489";
    
    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url, requestMap);
    log.info("测试查询讲师身份信息接口返回值:{}",response);
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "account": "2205489",
        "actor": "讲师1",
        "avatar": "//s1.videocc.net/default-img/avatar/teacher.png",
        "channelId": 2205489,
        "nickname": "葡萄籽",
        "passwd": "Kz37O6",
        "loginCode": null,
        "role": null
    }
}

异常示例

{
  "code": 400,
  "status": "error",
  "message": "invalid signature.",
  "data": ""
}

Last updated