最近更新时间：2023-04-07
调用视频云 openAPI 后返回数据采用统一格式，返回结果格式主要为 JSON 格式。本文档中的返回示例为了便于用户查看，做了格式化处理，实际返回结果是没有进行换行、缩进等处理的。
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
RequestId | String | 是 | 全局唯一的请求ID |
Code | String | 否 | 错误码 |
| Message | String | 否 | 错误描述 |
| Data | Object | 否 | 结果数据 |
调用直播 openAPI 后，如果返回的 HTTP 状态码为：200，代表调用成功。
{
"RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
"Data": {
/* 返回结果数据 */
}
}
调用直播API 后，如果返回的 HTTP 状态码为：400、403或者500，代表调用失败，系统将不会返回结果数据。此时，返回的消息体中包含：具体的错误代码、错误信息、全局唯一的请求ID：RequestId。您可以通过错误码定位问题。
{
"RequestId":"B6B9F518-60F8-4D81-9242-1207B356754D",
"Code":"InvalidUser.NotFound",
"Message":"The specified user does not exist."
}
| Http Code | Code | Message | 备注说明 |
|---|---|---|---|
| 200 | 0 | Success | 成功 |
| 404 | ActionInvalid.Error | An exception occured parameter, Action not found. | Action参数不存在 |
| 400 | RequiredParameter.Missing | Required parameter ${parameter} is missing. | 参数缺失，必传参数未传入 |
| 400 | InvalidStartTime.ValueNotSupported | StartTime must small than endTime. | 开始时间需要小于结束时间 |
| 400 | InvalidTime.ValueNotSupported | Time period should less than 31 day. | 时间范围不能超过31天 |
| 400 | InvalidTime.ValueNotSupported | Time period should less than 24 hours. | 时间范围不能超过24小时 |
| 400 | ParameterInvalid.Error | The specified parameter {parameter} is not valid. | 指定参数取值非法 |
| 400 | ParameterFormat.Error | The specified parameter {parameter} format error. | 指定参数格式不合法 |
| 400 | InvalidHLS | The Group needs to enable HLS. | 播放协议HLS，空间未开启HLS服务 |
| 400 | InvalidDevice.NotFound | The device does not exist in our records. | 设备不存在 |
| 400 | InvalidRecord.NotFound | The record does not exist in our records. | 录像不存在 |
| 400 | InvalidPictureId.NotFound | The PictureId does not exist in our records. | 抓拍图片ID不存在 |
| 400 | InvalidDevice | The device has been disabled. | 设备已停用 |
| 400 | InvalidGroup.NotFound | The group does not exist in our records. | 空间不存在 |
| 400 | InvalidGroup | The group has been disabled. | 空间已停用 |
| 400 | InvalidDevice.Offline | The device is offline. | 设备不在线 |
| 400 | InvalidChannel.Offline | The channel is offline. | 通道不在线 |
| 400 | InvalidDevice.Error | An error has occurred in the device. | 设备返回错误 |
| 400 | InvalidDevice.Unregistered | The device is not registered. | 设备未注册 |
| 400 | InvalidTime.Malformed | The specified parameter StartTime and EndTime is not valid. | 时间参数不合法 |
| 400 | SipServer.Error | 信令服务code:{err_code}, msg:{err_msg} | SIP服务错误 |
| 400 | SipServer.DeviceRespCodeError | 设备响应码 | SIP服务错误，设备响应错误码 |
| 400 | SipServer.DeviceRespBodyError | 0（消息体为空），1（消息体解析失败） | SIP服务错误，设备响应消息解析错误 |
| 400 | SipServer.WaitDeviceRespTimeout | SIP服务错误，等待设备响应超时 | |
| 400 | TaskServer.Error | 任务调度服务code:{err_code}, msg:{err_msg} | TaskServer服务错误 |
| 400 | Invalid.Device.Protocol | The Device does not support local record. | 设备不支持本地录像 |
400 | InvalidTask.Status | This Task status is invalid. | 本地上传任务状态非法 |
| 400 | MissingParameter.TaskId | The TaskId should not be null. | 本地上传任务ID不能为空 |
| 400 | InvalidTask.NotFound | The task does not exist in our records. | 本地上传任务不存在 |
| 400 | CallbackEventFlagsFormat.Error | The specified parameter CallbackEventFlags is too long. | 空间回调事件长度超长 |
| 400 | CallbackStatus.Error | The specified parameter CallbackEventFlags must not start event when Callback is empty. / The specified parameter CallbackEventFlags must start event when Callback is not empty. | 空间回调地址与回调事件状态错误 |
| 400 | CallbackConfig.Error | The specified parameter CallbackEventFlags and Callback must be empty or not empty at sametime. | 空间回调参数设置错误 |
| 400 | DeviceUserConfig.Error | The specified parameter UserName and Password must be empty or not empty at sametime. | 设备用户信息设置错误 |
| 500 | InternalServerError.Error | Service internal error. | 服务内部错误 |