From e60a697b204eb617786d0801afea348be3513642 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Thu, 26 Sep 2024 17:04:36 +0800 Subject: [PATCH 1/2] Optimize Error Code 202 for Android/iOS/Unity/Windows/HarmonyOS --- docs/document/android/error.md | 2 +- docs/document/harmonyos/error.md | 2 +- docs/document/ios/error.md | 2 +- docs/document/server-side/chatroom_attribute.md | 2 +- docs/document/unity/error.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/document/android/error.md b/docs/document/android/error.md index 1685b4df6..a2c04a92c 100644 --- a/docs/document/android/error.md +++ b/docs/document/android/error.md @@ -28,7 +28,7 @@ Android 中错误码的类为 `EMError`。 | 110 | INVALID_PARAM | 参数无效。 | | 200 | USER_ALREADY_LOGIN | 用户已登录：该用户 ID 已经登录。 | | 201 | USER_NOT_LOGIN | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 | -| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般为 token 无效或已过期。 | +| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 | | 203 | USER_ALREADY_EXIST | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 | | 204 | USER_NOT_FOUND | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 | | 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 | diff --git a/docs/document/harmonyos/error.md b/docs/document/harmonyos/error.md index 07ac057d0..d51722ba4 100644 --- a/docs/document/harmonyos/error.md +++ b/docs/document/harmonyos/error.md @@ -27,7 +27,7 @@ HarmonyOS 中错误码的类为 `ChatError`。 | 110 | INVALID_PARAM | 参数无效。 | | 200 | USER_ALREADY_LOGIN | 用户已登录：该用户 ID 已经登录。 | | 201 | USER_NOT_LOGIN | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 | -| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般为 token 无效或已过期。 | +| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 | | 203 | USER_ALREADY_EXIST | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 | | 204 | USER_NOT_FOUND | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 | | 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 | diff --git a/docs/document/ios/error.md b/docs/document/ios/error.md index 1306ed87f..619c67ff0 100644 --- a/docs/document/ios/error.md +++ b/docs/document/ios/error.md @@ -30,7 +30,7 @@ iOS 的错误码只有当操作出错的时候才会有返回值，否则返回 | 110 | EMErrorInvalidParam | 参数无效。 | | 200 | EMErrorUserAlreadyLoginSame | 当前用户已经登录：该用户 ID 已经登录。 | | 201 | EMErrorUserNotLogin | 用户未登录：例如，如果未登录成功时调用发送消息或群组操作的 API 会提示该错误。 | -| 202 | EMErrorUserAuthenticationFailed | 用户鉴权失败：一般为 token 无效或已过期。 | +| 202 | EMErrorUserAuthenticationFailed | 用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 | | 203 | EMErrorUserAlreadyExist | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 | | 204 | EMErrorUserNotFound | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。| | 205 | EMErrorUserIllegalArgument | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 | diff --git a/docs/document/server-side/chatroom_attribute.md b/docs/document/server-side/chatroom_attribute.md index 3305d5fac..f9bc090f9 100644 --- a/docs/document/server-side/chatroom_attribute.md +++ b/docs/document/server-side/chatroom_attribute.md @@ -463,7 +463,7 @@ DELETE https://{host}/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user ```shell # 将 替换为你在服务端生成的 App Token -DELETE -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '{ +curl -X DELETE POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer ' -d '{ "keys": ["key1","key2"] }' 'https://XXXX/XXXX/XXXX/metadata/chatroom/662XXXX13/user/user1' ``` diff --git a/docs/document/unity/error.md b/docs/document/unity/error.md index f5ac415e6..c8f18f997 100644 --- a/docs/document/unity/error.md +++ b/docs/document/unity/error.md @@ -49,7 +49,7 @@ SDKClient.Instance.Login(username, passwd, | 110 | INVALID_PARAM | 参数无效。 | | 200 | USER_ALREADY_LOGIN | 用户已登录：该用户 ID 已经登录。 | | 201 | USER_NOT_LOGIN | 用户未登录：例如，如果未登录成功时发送消息或者使用群组操作的 API，SDK 会提示该错误。 | -| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般为 token 无效或已过期。 | +| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 | | 203 | USER_ALREADY_EXIST | 用户已经存在：注册用户时，传入的的用户 ID 已经存在会提示该错误。 | | 204 | USER_NOT_FOUND | 用户不存在：例如，登录或获取用户会话列表时，用户 ID 不存在。 | | 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：例如，创建用户或更新用户属性时，用户 ID 为空或无效。 | From a69853022287a03859cf40b779fa2dc53afa9873 Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Thu, 26 Sep 2024 17:06:25 +0800 Subject: [PATCH 2/2] modify --- docs/document/windows/error.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/document/windows/error.md b/docs/document/windows/error.md index c48afa937..b14934a7e 100644 --- a/docs/document/windows/error.md +++ b/docs/document/windows/error.md @@ -48,7 +48,7 @@ SDKClient.Instance.Login(username, passwd, | 109 | TOKEN_WILL_EXPIRE | 声网 token 即将过期：超出声网 token 有效期一半时间时会开始回调此错误码。 | | 200 | USER_ALREADY_LOGIN | 用户已经登录：同一个用户 ID 已经登录。 | | 201 | USER_NOT_LOGIN | 用户未登录：例如，如果未登录成功时发送消息，或者使用群组操作的 API，SDK 会提示该错误。 | -| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：一般是 token 鉴权失败或者 token 已经过期。 | +| 202 | USER_AUTHENTICATION_FAILED | 用户鉴权失败：
- 若使用用户 ID 和密码登录，用户 ID 或密码不正确时会上报改错误；
- 若使用用户 ID 和用户 token 登录，一般为用户 token 无效或已过期。 | | 203 | USER_ALREADY_EXIST | 用户已经存在：注册用户 ID 时如果该 ID 已经存在会提示该错误。 | | 204 | USER_NOT_FOUND | 用户不存在：例如，登录或者获取用户会话列表时用户 ID 不存在。 | | 205 | USER_ILLEGAL_ARGUMENT | 用户参数不正确：比如创建用户 ID 时不符合格式要求， 或者更新用户属性时用户参数为空等。 |