Get Viewer Watch API Token

Updated: 2022-09-02 18:08:07

API Description

1、获取观众观看调用接口token
2、该token用于观看端的sdk调用直播api的相关接口
3、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/watch/get-api-token

Request Method

POST

API Constraints

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

Request Parameters

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret used to generate the signature is critical for communication data security. It must never be used directly on the client side. All APIs must be called through your own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID
viewerId	true	String	Viewer ID, length: 1-64 characters
nickname	false	String	Nickname
avatar	false	String	Viewer avatar
openid	false	String	WeChat openId
actor	false	String	User title

Example

http://api.polyv.net/live/v3/channel/watch/get-api-token

Form parameters:

viewerId=test1234&appId=frlr1zazn3&sign=342122E84F0BD86BF217F1A46942D79D&userId=1b448be323&channelId=2094979&timestamp=1634264231586

Response Parameters

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	Empty on failure, channel information on success [See data field description]

data Field Description

Parameter	Type	Description
token	String	API call token, valid for 8 hours

Java Request Example

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

/**
 * 获取观众观看调用接口token
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetApiToken() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/watch/get-api-token";
    String channelId = "2094979";
    String viewerId = "test1234";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("userId", userId);
    requestMap.put("viewerId", viewerId);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试获取观众观看调用接口token，返回值：{}", response);
    //do somethings
    
}

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "token": "fri7txjyy1"
    }
}

Error Example

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

Live Streaming Server API