Query Administrator Identity Information

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

API Description

1、通过频道号，查询管理员身份信息
2、接口支持https协议
3、接口URL中的{channelId}为"频道号"

API URL

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

Online API Call

Request Method

GET

API Constraints

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

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
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 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]

Example

http://api.polyv.net/live/v2/channelSetting/2191569/get-chat-admin?appId=frlr1zazn3&sign=056E68539013A10871D522FD5CD6C2E2&timestamp=1616643463290

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, provides error details when code is 400 or 500
data	Object	Administrator identity information [See data field description]

data Field Description

Parameter	Type	Description
actor	String	Administrator title
nickname	String	Administrator nickname
avatar	String	Administrator avatar

Java Request Example

For quick integration of the base code, download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained 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 testGetAdminInfo() 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+"/get-chat-admin";

        //http 调用逻辑
        Map<String,String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("timestamp",timestamp);
        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": {
    "actor": "管理员",
    "nickname": "管理员",
    "avatar": "//s1.videocc.net/default-img/avatar/teacher.png"
  }
}

Error Example

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

Live Streaming Server API