Modify Channel Custom Authorization Settings

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

API Description

1、修改频道自定义授权设置
2、接口URL中的{userId}为直播账号ID
3、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelSetting/{userId}/oauth-custom

Online API Call

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 Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details
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 side. 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
customUri	true	String	Custom authorization address
channelId	false	String	Channel ID to set. If not submitted or set to 0, applies to all channels

Example

http://api.polyv.net/live/v2/channelSetting/1b448be323/oauth-custom

Form Parameters:

customUri=http%3A%2F%2Fmywebsite.com%2FmyDefinedUrl.php&appId=frlr1zazn3&sign=5CAA286F2278FDEBE90A253506E16790&channelId=2191532&timestamp=1621843813824

Response Parameters 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, provides error details when code is 400 or 500
data	Array	Authorization info on success, empty string on failure See data field description

Data Field Description

Parameter	Type	Description
channelId	String	Set channel ID
secretKey	String	External authorization secretKey corresponding to the channel ID

Java Request Example

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

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

private static final Logger log = LoggerFactory.getLogger(WatchConditionTest.class);
/**
 * 修改频道自定义授权设置
 * @throws IOException
 */
@Test
public void testSetAuthorizedAddress() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/live/v2/channelSetting/%s/oauth-custom",userId);
    String channelId = "2191532";
    String customUri = "http://mywebsite.com/myDefinedUrl.php";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);

    requestMap.put("channelId",channelId);
    requestMap.put("customUri",customUri);


    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试修改频道自定义授权设置接口返回值：{}",response);
    //do somethings

}

Response Example

See Global Error Description for system-wide error descriptions.

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [{
        "channelId": 2191532,
        "secretKey": "6mu6166v4l"
    }]
}

Error Example

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