Query Account Information

Updated: 2025-09-04 09:23:43

API Description

1、查询用户账号信息接口
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/user/get-info

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for 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 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 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

https://api.polyv.net/live/v3/user/get-info?appId=frlr1zazn3&sign=610EA5FE046D660D7465F4FB34E417BF&timestamp=1621844549569

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	Returns user account information on success See Data Field Description

Data Parameter Description

Parameter	Type	Description
userId	String	POLYV user ID, same as on the Polyv official website. Path: Official Website -> Login -> Live (Developer Settings)
email	String	User email
maxChannels	Integer	Maximum number of channels
totalChannels	Integer	Total number of channels
availableChannels	Integer	Number of available channels
linkMicLimit	Integer	Maximum number of simultaneous connections for the account
linkMicLimit	Integer	Maximum number of simultaneous connections for the account
watchDomain	String	Watch page domain

Java Request Example

For quick integration, please 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 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(AccountTest.class);
/**
 * 查询账号信息
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetUserInfo() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/user/get-info";

    //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);
    //do somethings

}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "userId": "1b448be323",
        "email": "sdk-demo@polyv.net",
        "maxChannels": 100,
        "totalChannels": 64,
        "availableChannels": 36,
        "linkMicLimit": 16
    }
}

Error Example

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