2024/08/27 15:30:34
响应状态码
在调用灵动课堂 RESTful API 过程中,你可能收到如下 HTTP 状态码:
- 如果 HTTP 状态码为
200
,则请求成功。 - 如果 HTTP 状态码不为
200
,则请求失败。你可以根据对应的响应 Body 中可能出现的字段排查问题。
响应示例
成功返回结果
当接口请求成功时,所有接口响应的 HTTP 状态码均为 200
。返回示例如下:
JSON
{
"status": 200,
"body":
{
"code": 0,
"msg": "Success",
"ts": 1610450153520
}
}
错误返回结果
-
若为客户端错误,HTTP 状态码(
status
字段)为40x
。返回示例如下:JSON{
"status": 404,
"body":
{
"code": 20404100,
"msg": "Room not exists!",
"ts": 1610450153520
}
} -
若为服务端错误,HTTP 状态码(
status
字段)为50x
。返回示例如下:JSON{
"status": 500,
"body":
{
"msg": "Internal Server Error",
"code": 500,
"ts": 1610167740309
}
}
响应状态码
下表展示在调用灵动课堂 RESTful API 时,你可能会收到的所有响应状态码。
状态码 | code 字段 | 描述 | 解决方法 |
---|---|---|---|
200 OK | 0 | 请求成功。 | 无需处理。 |
400 Bad Request | 400 | 请求参数错误。 | 检查并修正请求参数。具体信息可参考响应体中的提示内容。 |
401 Unauthorized | N/A | 可能的原因:
| 验证并更新 App ID 或 Token Authorization 信息。 |
403 Forbidden | 30403200 | 课堂已禁言,无法发送聊天消息。 | 检查课堂状态,解除禁言。 |
404 Not Found | N/A | 服务器无法找到请求的资源。 | 确认请求的 URL 是否正确。 |
404 Not Found | 20404100 | 课堂不存在。 | 检查课堂 ID 是否正确。 |
404 Not Found | 20404200 | 用户不存在。 | 检查用户 ID 是否正确。 |
410 Gone | 30410100 | 课堂已结束。 | 确认课堂状态,重新开始课堂或创建新的课堂。 |
409 Conflict | 30409410 | 录制状态冲突,录制未开始。 | 检查录制状态,确保录制已开始。 |
409 Conflict | 30409411 | 录制状态冲突,录制未结束。 | 检查录制状态,确保录制已结束。 |
400 Bad Request | 30400412 | 参数 rootUrl 不能为空。 | 提供有效的 rootUrl 参数。 |
409 Conflict | 30409100 | 课程状态冲突,课程已开始。 | 确认课程状态,避免重复操作。 |
409 Conflict | 30409101 | 课程状态冲突,课程已结束。 | 确认课程状态,避免重复操作。 |
400 Bad Request | 30400100 | 租户 ID 不能为空。 | 提供有效的租户 ID。 |
429 Too Many Requests | N/A | 接口被限流。 | 减少请求频率,稍后重试。 |
500 Internal Server Error | 500 | 服务器内部错误,无法完成请求。 | 联系技术支持或管理员,检查服务器日志。 |
503 Service Unavailable | N/A | 服务器内部错误,充当网关或代理的服务器未从远端服务器获取响应。 | 稍后重试,或联系技术支持检查远端服务器状态。 |