暂停云端播放任务

更新时间: 2024/03/25 11:00:43

调用此接口暂停虚拟播放器的播放任务。

接口地址信息

  • 请求方法:POST

  • URL:

    网易云信为该功能提供以下两个 API 请求地址,使用 V3 地址需在 URL 中指定 cname,您可以根据业务需求调用任一接口。

    • https://logic-dev.netease.im/v2/api/task/pause
    • https://logic-dev.netease.im/v3/api/task/pause?cname={cname}

URL中参数说明:

参数名称 类型 示例 描述
cname String abc 房间名称。仅在调用 V3 接口时需要设置。

接口请求频率

默认上限为 50 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制

注意事项

云端播放任务处于暂停状态时,如果调用了更新云端播放任务 接口并执行成功,则云端播放任务会恢复播放状态,而且若更新云端播放任务时配置了新的媒体流地址 streamUrl ,此时将播放新的媒体流。

请求参数

  • 请求中 Header 的设置请参考请求结构描述。

  • 请求中 Body 须为 JSON 格式,参数说明如下:

参数名称
类型
是否必选
示例
描述
cid Number 必选,仅适用于 V2 接口 1344332***3399 房间 ID。
该 ID 为创建云端播放任务接口调用成功后返回的房间 ID,仅在调用 V2 接口时需要设置。
taskType Int 必选 2 服务器任务类型。固定为 2。
taskId String 必选 2a784467d647bb87b60b719f6fa56333 任务唯一标识符,房间内唯一。调用创建云端播放任务接口后,可在返回 Body 中获取 taskId。

返回参数

参数名称 类型 示例 描述
taskId String 2a784467d647bb87b60b719f6fa56333 任务唯一标识符,房间内唯一。

示例

请求示例

{
    "cid":114450***259296,
    "requestId":"随机字符串用作问题排查",
    "taskType": 2,
    "taskId":"2a784467d647bb87b60b719f6fa56333"
}

返回示例

{
    "code"200"result": {
        "taskId": "2a784467d647bb87b60b719f6fa56333"
    }
}

状态码

返回内容中,code 为 200 表示调用正常。
若 code 为其他值,请根据 code 与 errmsg 在在线媒体流状态码中查看问题原因。

此文档是否对你有帮助?
有帮助
去反馈
  • 接口地址信息
  • 接口请求频率
  • 注意事项
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例
  • 返回示例
  • 状态码