接口功能介绍
本接口用于启动设备拉流，该操作会启动设备上的所有流。
接口约束
开始实时推流前确保设备在线。
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。
URI
PUT /v2/devices/*/startPlay
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 设备ID。 | 32388487739092996 |
Query参数
无
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| DeviceId | String | 设备ID。 | 713412235594514432 | |
| PushUrl | String | 推流URL。 | rtmp://192.0.0.1:1935/live/323884***?AccessKeyId=O0G0BPB***&Signature=X7rcepN*** | |
| CreatedTime | String | 启动设备拉流任务创建时间。 | 2023-04-20 18:27:22 | |
| UpdatedTime | String | 启动设备拉流任务更新时间。 | 2023-04-20 18:27:22 | |
| RequestId | String | 请求ID。 | b8ce1ab26af942c0a8b220026614064b |
枚举参数
无
请求示例
请求url
PUT '/v2/devices/713412235594514432/startPlay'
请求头header
无
请求体body
无
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "b8ce1ab26af942c0a8b220026614064b","returnObj": {"DeviceId": "713412235594514432","PushUrl": "rtmp://192.0.0.1:1935/live/323884***?AccessKeyId=O0G0BPB***&Signature=X7rcepN***","CreatedTime": "2023-04-20 18:27:22","UpdatedTime": "2023-04-20 18:27:22","RequestId": "b8ce1ab26af942c0a8b220026614064b"}}
状态码
请参考 状态码
错误码
请参考 错误码
