Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify RESTful Error and Call Frequency Doc #18

Merged
merged 2 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions docs/document/server-side/error.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
| 404 | (未找到)服务器找不到请求的接口。 |
| 405 | (请求方式错误)请按照声网官网接口说明,正确的使用接口 GET,POST 等请求方式。 |
| 408 | (请求超时)服务器等候请求时发生超时。 |
| 409 | 并发调用[通过用户 ID 获取用户 token 的 API](easemob_user_token.html#通过用户-id-获取用户-token) 时若设置了自动创建用户则报错。也就是说,调用了该 API 时将 `grant_type` 设置为 `inherit`,`autoCreateUser` 设置为 `true`,则会上报该错误。如果获取 token 的用户已注册,并发调用该 API 则不会报错。|
| 409 | (并发操作)例如,并发调用了修改消息接口修改同一消息。 |
| 413 | (消息附件过大)调用[上传文件](message_download.html#上传文件)接口上传的消息附件超过了最大限制。 |
| 415 | 请求体的类型不支持。 |
| 429 | (服务不可用)请求接口超过调用频率限制,即接口被限流。或超过社区版限制,如有需要可联系商务。 |
Expand Down Expand Up @@ -51,16 +51,14 @@

## Token 相关错误码

1. 关于调用获取 Token 相关的 REST API 的错误码,详见[获取 App Token](easemob_app_token.html)和[获取用户 Token](easemob_user_token.html)接口的错误码列表。

2. 调用 REST API 过程中,Token 相关的错误码如下表所示:
调用 RESTful API 过程中,Token 相关的错误码如下表所示:

| HTTP 状态码 | 错误类型 | 错误提示 | 可能原因 | 处理建议 |
| ---- | ---------- | ----------------- | ----------------- | ----------------- |
| 401 | unauthorized | "registration is not open, please contact the app admin" | 调用[注册单个用户](account_system.html#注册单个用户)和[批量注册用户](account_system.html#批量注册用户)的 RESTful 接口时,未传入 App Token 或传入了错误的 App Token 时提示该错误,例如 Token 已过期或格式不正确。 | 请传入有效 token。|
| 401 | unauthorized | "Unable to authenticate due to expired access token" | 调用 RESTful 接口发送请求时使用的 App Token 过期或未传入 App Token。 该错误码针对除[注册单个用户](account_system.html#account_system.html#注册单个用户)之外的 RESTful 接口有效。 | 请传入有效 token。|
| 401 | unauthorized | "Unable to authenticate due to expired access token" | 调用 RESTful 接口发送请求时使用的 App Token 过期或未传入 App Token。 该错误码针对除[注册单个用户](account_system.html#注册单个用户)之外的 RESTful 接口有效。 | 请传入有效 token。|
| 401 | auth_bad_access_token | "Unable to authenticate due to corrupt access token" | 调用 RESTful 接口发送请求时使用的 App Token 格式错误。 该错误码针对除[注册单个用户](account_system.html#注册单个用户)之外的 RESTful 接口有效。 | 请传入有效 token。|
| 401 | auth_bad_access_token | "Unable to authenticate" | 调用 RESTful 接口发送请求时使用的 App Token 无效。App Token 的格式正确,但不是由接收请求的服务器生成的,导致服务器无法识别该 Token。 该错误码针对除[注册单个用户](/document/server-side/account_system.html#注册单个用户)和[批量注册用户](account_system.html#批量注册用户)两个 RESTful 接口之外的接口有效。 | 请传入有效 token。|
| 401 | auth_bad_access_token | "Unable to authenticate" | 调用 RESTful 接口发送请求时使用的 App Token 无效。App Token 的格式正确,但不是由接收请求的服务器生成的,导致服务器无法识别该 Token。 该错误码针对除[注册单个用户](account_system.html#注册单个用户)和[批量注册用户](account_system.html#批量注册用户)两个 RESTful 接口之外的接口有效。 | 请传入有效 token。|

## 用户 ID 不存在错误码

Expand Down
6 changes: 3 additions & 3 deletions docs/document/server-side/limitationapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

除部分 API 接口有特殊说明外,API 调用频率限制默认为 100 次/秒,你可以按模块查看每个接口的调用频率限制。

在环信即时通讯 IM 系统中,大部分客户端接口的调用实际上是通过对应的 RESTful API 来实现的。
- 下表中标注 * 的 RESTful API 没有对应的客户端接口,因此它们的调用频率仅由相应的 RESTful API 的调用频率决定。若这些接口的调用频率达到上限,你可以联系环信商务提升
- 其他接口,其调用频率则为 RESTful API 和对应客户端接口调用频率的总和。若这些接口的调用频率达到上限,你可以查看是否是客户端 API 调用过于频繁。如果需要提升调用频率上限,可联系环信商务
在声网即时通讯 IM 系统中,大部分客户端接口的调用实际上是通过对应的 RESTful API 来实现的。
- 下表中标注 * 的 RESTful API 没有对应的客户端接口,因此它们的调用频率仅由相应的 RESTful API 的调用频率决定。若这些接口的调用频率达到上限,你可以联系声网商务提升
- 其他接口,其调用频率则为 RESTful API 和对应客户端接口调用频率的总和。若这些接口的调用频率达到上限,你可以查看是否是客户端 API 调用过于频繁。如果需要提升调用频率上限,可联系声网商务


## 消息管理
Expand Down