编辑系列直播场次

下载 PDF

下载 Word

接口描述

1、编辑系列直播场次
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/channel/session/new/update

在线API调用

请求方式

POST

接口约束

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

请求参数描述

请求体参数描述

示例

http://api.polyv.net/live/v4/channel/session/new/update?appId=frlr1zazn3&timestamp=1632809855078&channelId=2588188&sign=D02FA683640135D843D485EE84F6632A

请求体json参数：

{
  "sessionId": "e9s2h3jd8f",
  "name": "专题直播-新品发布会-修订版",
  "planStartTime": 1761201943000,
  "planEndTime": 1761201953000,
  "interactionScriptId": 123,
  "playType": "normal",
  "splashImg": "https://example.com/splash-update.jpg",
  "splashLargeImg": "https://example.com/splash-large-update.jpg",
  "splashImgBackgroundId": "2",
  "streamType": "client",
  "videoPoolId": "vid_abc123",
  "videoSource": "Material",
  "playbackEnabled": "Y",
  "playbackOrigin": "vod",
  "playbackVideoId": "c81017120b"
}

响应参数描述

data字段说明

playbackConfig字段描述

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。

强烈建议您使用直播Java SDK完成API的功能对接，直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 更新新版场次
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSessionNewUpdateV4() throws IOException, NoSuchAlgorithmException {
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    String url = "http://api.polyv.net/live/v4/channel/session/new/update";

    Map<String, String> query = new HashMap<>();
    query.put("appId", appId);
    query.put("timestamp", timestamp);
    query.put("channelId", "2588188");
    query.put("sign", LiveSignUtil.getSign(query, appSecret));

    Map<String, Object> body = new HashMap<>();
    body.put("sessionId", "e9s2h3jd8f");
    body.put("name", "专题直播-新品发布会-修订版");
    body.put("planStartTime", "1761201943000");
    body.put("planEndTime", "1761201953000");
    body.put("ignoreStartTimeVerify", true);
    body.put("interactionScriptId", 123);
    body.put("playType", "normal");
    body.put("splashImg", "https://example.com/splash-update.jpg");
    body.put("splashLargeImg", "https://example.com/splash-large-update.jpg");
    body.put("splashImgBackgroundId", "2");
    body.put("streamType", "client");
    body.put("videoPoolId", "vid_abc123");
    body.put("videoSource", "Material");
    body.put("playbackEnabled", "Y");
    body.put("playbackOrigin", "vod");
    body.put("playbackVideoId", "c81017120b");

    String fullUrl = HttpUtil.appendUrl(url, query);
    String response = HttpUtil.postJsonBody(fullUrl, JSON.toJSONString(body), null);
    log.info("返回值：{}", response);
}

响应示例

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

成功示例

{
  "code": 200,
  "status": "success",
  "requestId": "847f0716fa76461baf8979aaa4415dc3.67.16342672396023837",
  "data": {
    "channelId": 2588188,
    "userId": "1b448be323",
    "sessionId": "e9s2h3jd8f",
    "name": "专题直播-新品发布会-修订版",
    "endTime": 1761201953000,
    "status": "end",
    "createdTime": 1761201953000,
    "planStartTime": 1761201953000,
    "planEndTime": 1761201953000,
    "splashImg": "https://example.com/splash-update.jpg",
    "splashLargeImg": "https://example.com/splash-large-update.jpg",
    "splashImgBackgroundId": 2,
    "pushClient": "client",
    "type": "manual",
    "playbackEnabled": "Y",
    "playbackConfig": {
      "playbackEnabled": "Y",
      "playbackOrigin": "vod",
      "videoId": "c81017120b"
    }
  },
  "success": true
}

异常示例

{
  "code": 400,
  "status": "error",
  "requestId": "4081dbac03e6441e8bdd301d8feee5a2.124.16360831818611581",
  "error": {
    "code": 20001,
    "desc": "application not found."
  },
  "success": false
}