返回结果

更新时间: 2024/07/24 10:02:26

视频会议 Restful API 返回结果的格式统一,由固定的返回参数和返回结果(Body)中 data 属性内包含的参数组成。

返回参数

参数名称 类型 描述
code Integer 状态码。0 表示成功,其他错误码请参考 错误码
msg String 请求状态信息。
requestId String 请求的唯一标识。
cost String NERoom 服务器处理该请求的耗时。单位为毫秒(ms)。
ts Long NERoom 服务器处理该请求的时间戳。单位为毫秒(ms)。
data Object 返回的业务数据对象。内含的参数根据每个 API 的设定会有所不同。

正常返回示例

接口调用成功后,正常返回示例如下。

JSON{ 
    "code": 0,
    "msg": "Success",
    "ts": 1646136664068,
    "requestId": "7c4b6d9c3e9d42*****cc6e3a4d995",
    "cost": "489ms",
    "data": {
            "pushUrl":"https://domain/streamName",
            "pullHlsUrl":"https://domain/streamName",
            "pullRtmpUrl":"https://domain/streamName",
            "pullHttpUrl":"https://domain/streamName",
            "pullRtsUrl":"https://domain/streamName"
 } 
}

异常返回示例

接口调用出错后,会返回错误码、错误信息,您可根据错误码来判断异常原因。

JSON{
    "code": 401,
    "msg": "Bad checksum:8d710597f32459326a0***",
    "requestId": "64daaec950***fd85304fee1f0e"
    "cost": "3ms",
}
此文档是否对你有帮助?
有帮助
去反馈
  • 返回参数
  • 正常返回示例
  • 异常返回示例