使用 SID 强制断开推流
更新时间不可用
使用推流会话 ID 强制断开正在进行的推流。
DELETE
https://api.sd-rtn.com/{region}/v1/projects/{appId}/rtls/ingress/online-streams/{sid}使用推流会话 ID(SID)断开指定的正在进行的推流。
你可以结合该接口和销毁推流码 API,实现禁用流的功能。销毁推流码只会将推流码从数据库删除,之后就不能再使用该推流码,但不能断开正在进行的推流。如需断开正在进行的推流,你可以参考如下操作:
- 方法一:先调用销毁推流码 API,再使用本接口断开正在进行的推流。
- 方法二:使用声网封禁用户权限:将用户一次性踢出频道 API 同样也可以强制断开推流,如果已经集成过踢人接口,可以继续使用踢人接口来断开推流。
注意
一定要先销毁推流码,否则单独使用本接口强制断开后,推流软件会立即重连上来,此时会生成一个新的推流会话(对应一个新的 sid),断开失败。
鉴权
regionstring必填
创建推流码的区域。声网支持分区域创建推流码,目前支持以下区域:
cn:中国大陆ap:除中国大陆以外的亚洲区域na:北美eu:欧洲
注意
- 请确保设置的
region与输入的源流在同一个区域。 - 请确保设置的
region与推流使用的域名在同一个区域。 - 请确保传入
region的值为小写。
appIdstring必填
声网为每个开发者提供的 App ID。在声网控制台创建一个项目后即可得到一个 App ID。App ID 是一个项目的唯一标识。
sidstring必填
推流会话 ID(Session ID),是每次发起的推流任务的唯一标识。可以通过查询当前在推流列表 API 获得,也可通过接收消息通知回调的 Payload 获取。
X-Request-IDstring本次请求的 UUID(通用唯一识别码)。传入该字段后,声网服务器会在响应 Header 中返回该字段。声网推荐你对 X-Request-ID 赋值。如果不赋值,声网服务器会自动生成一个 UUID 传入。
响应
请求示例
curl --request DELETE \
--url "https://api.sd-rtn.com/:region/v1/projects/:appId/rtls/ingress/online-streams/:sid" \
--header 'Authorization: Basic <credentials>' \
--header 'X-Request-ID: <string>'响应示例
{
"status": "请求状态,值为 `success`。"
}