Modify Administrator Identity Information

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

API Description

1、通过频道号，修改管理员信息，提交参数都不能为空
2、接口URL中的{channelId}为"频道号"
3、（actor, nickname, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
4、接口支持https协议

API URL

http://api.polyv.net/live/v2/channelSetting/{channelId}/set-chat-admin

Request Method

POST

API Constraints

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

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 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 never 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
nickname	true	String	Administrator nickname, length cannot exceed 8 characters
actor	true	String	Administrator title, length cannot exceed 4 characters
avatar	true	File	Administrator avatar, supports jpg, jpeg, png formats, size cannot exceed 2Mb

Example

http://api.polyv.net/live/v2/channelSetting/2191569/set-chat-admin

Form Parameters:

actor=管理员1&appId=frlr1zazn3&nickname=张三&sign=FA7ABEBFC204253D6E44699DD8C84866&timestamp=1616644515871

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 information
message	String	Response description message, provides error details when code is 400 or 500
data	String	Empty on failure, "Modification successful" on success

Java Request Example

For quick integration of the base code, please 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 include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded 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 testUpdateAdminInfo() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String appId = super.appId;
        String appSecret = super.appSecret;
        String timestamp = String.valueOf(System.currentTimeMillis());

        //业务参数
        String channelId = "2191569";
        String url = "http://api.polyv.net/live/v2/channelSetting/"+channelId+"/set-chat-admin";
        String nickname = "张三";
        String actor = "管理员1";
        File avatar = new File("/Users/apple/Documents/证件照/证件照1.jpeg");

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        requestMap.put("nickname",nickname);
        requestMap.put("actor",actor);
        requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
        Map<String, File> fileMap = new HashMap<String, File>();
        fileMap.put("avatar",avatar);
        String response = HttpUtil.postFile(url,requestMap,fileMap,"UTF-8");
        log.info("测试修改管理员身份信息接口返回值：{}",response);

}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code": 200, 
    "status": "success", 
    "message": "", 
    "data": "修改成功"
}

Error Example

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

Live Streaming Server API