Get Instructor Information

Updated: 2023-04-25 15:34:55

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId See Obtaining Keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must not be stored or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` See Signature Generation Rules
channelId	true	String	Channel ID

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See Global Error Description
status	String	Response status text
message	String	Response description, assists in describing error reasons when code is 400 or 500
data	Object	Returns true on success, empty on error. See Data Field Description

Data Parameter Description

Parameter	Type	Description
account	String	Instructor ID, same as channel ID
actor	String	Instructor title
avatar	String	Instructor avatar, e.g., //liveimages.videocc.net/uploaded/images/2023/04/gjps9etdpx.jpg
channelId	String	Channel ID
nickname	String	Instructor nickname
passwd	String	Instructor login password
loginCode	String	This field is null
role	String	This field is null

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases HttpUtil.java and LiveSignUtil.java are included in the download file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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);
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "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
    }
}

Error Example

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