保利威文档中心

帮助中心

直播服务端 API

重置分账号应用密匙

更新时间：2022-09-21 18:29:03

接口描述

1、重置分账号应用密匙
2、（timestamp, appId, sign）签名参数需通过url传递
3、接口支持https协议

接口URL

http://api.polyv.net/live/v4/group/user/secret/reset

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、集团账号接口计算签名请使用集团主账号的appId、appSecret

3、应用密匙重置5分钟后生效

请求参数描述

参数名 必选 类型 说明
appId true String 集团主账号appId
timestamp true Long 当前13位毫秒级时间戳，3分钟内有效
sign true String 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
email true String 分账号邮箱

示例

http://api.polyv.net/live/v4/group/user/secret/reset?appId=ga1ayl6dh2&timestamp=1661443279000&sign=FD154894135E713FC2D0D64B2B33E72E&email=paasgrouptestpre01@polyv.net

响应参数描述

参数名 类型 说明
code Integer 状态码，与 http 状态码相同，用于确定基本的响应状态
status String 响应结果，由业务决定，成功返回success，失败返回error
success Boolean 是否成功响应
requestId String 请求ID，每次请求生成的唯一的 UUID，仅可用于排查、调试，不应该和业务挂上钩
error Object 状态码非200时的错误信息【详见Error字段描述】
data Object 【详见data字段说明】

Error参数描述

参数名 类型 说明
code Integer 错误代码，用于确定具体的错误原因
desc String 错误描述，与 error.code 对应

Data参数描述

参数名 类型 说明
appId String 应用ID
appSecret String 重置后的应用Secret
userId String 用户全局ID

Java请求示例

private static final Logger log = LoggerFactory.getLogger(GroupTestLive.class);
/**
 * 重置分账号应用密匙
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void groupSecretResetTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.groupAppId;
    String appSecret = super.groupAppSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/group/user/secret/reset";
    String email = "";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("email", email);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));

    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postFormBody(url, null);
    log.info("测试重置分账号应用密匙成功：{}", response);
    //do somethings
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "6c8c2d016ace4366a0d8fe2ff632ba28.72.16614432795402597",
    "data": {
        "appId": "gcx4zavev0",
        "appSecret": "50bxxxxxxxxxxxx68157635",
        "userId": "eaf4fead20"
    },
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}
联系客服，在线咨询