One Guest One Code Invitation Sales Information Query

Updated: 2025-01-10 15:44:27

Interface Description

1、一客一码邀请销售信息查询
2、接口支持https协议

Interface URL

https://api.polyv.net/live/v4/user/invite-customer/get

Online API Call

Request Method

GET

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface 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 and must never be saved or used directly on the client. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data.` See Signature Generation Rules
saleId	false	String	Sales ID (choose one with saleCode parameter)
saleCode	false	String	Sales invitation code (choose one with saleId parameter)

Example

https://api.polyv.net/live/v4/user/invite-customer/get?appId=frlr1zazn3&sign=7F2F91A6A01C9BBA844141088C5E9F71&timestamp=1672884419075&saleId=e4a975gao

Response Parameter Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	See data Field Description

Error Parameter Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

data Parameter Description

Parameter	Type	Description
userId	String	POLYV user ID, consistent with the Polyv official website. Access path: Official website -> Login -> Live (Development Settings)
childUserId	String	Sub-account ID
childName	String	Sub-account name
childEmail	String	Sub-account email
avatar	String	Sub-account avatar
telephone	String	Sub-account phone number

Java Request Example

For quick integration of basic 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 in the downloaded file.

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

/**
 * 查询页脚设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void getInviteCustomeSaleTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "https://api.polyv.net/live/v4/user/invite-customer/get";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("saleId", "e4a975gao");
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    String response = HttpUtil.get(url, requestMap);
    
    log.info("测试查询销售信息成功：{}", response);
    //do somethings
    
}

Response Example

For system-wide error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "f14199d88cde4db4920d1fc1deb5d2d2.71.16728211496668607",
    "data": {
        "userId": "1b448be323",
        "childUserId": "1b448be326",
        "childName": "保利威提供技术支持",
        "childEmail": "xx@polyv.net",
        "telephone": "13888888888",
        "avatar": "https://www.polyv.net"
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API