diff --git a/docs/.vuepress/public/images/applet/applet-demo.png b/docs/.vuepress/public/images/applet/applet-demo.png index fe6776e6e..d77345021 100644 Binary files a/docs/.vuepress/public/images/applet/applet-demo.png and b/docs/.vuepress/public/images/applet/applet-demo.png differ diff --git a/docs/document/android/login.md b/docs/document/android/login.md index 4bc165523..d3d348aae 100644 --- a/docs/document/android/login.md +++ b/docs/document/android/login.md @@ -4,7 +4,9 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: + +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 - 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 @@ -15,9 +17,9 @@ EMClient.getInstance().createAccount(mAccount, mPassword);// 同步方法。 ``` -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 diff --git a/docs/document/applet/login.md b/docs/document/applet/login.md index fb38eace4..eb0e1d81f 100644 --- a/docs/document/applet/login.md +++ b/docs/document/applet/login.md @@ -4,22 +4,15 @@ ## 用户注册 -用户注册支持以下方式: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -示例代码如下: - -```javascript -conn.registerUser({ - username: "user1", - password: "xxx", -}); -``` +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 登录方式 diff --git a/docs/document/flutter/login.md b/docs/document/flutter/login.md index 962b16f49..81921bf41 100644 --- a/docs/document/flutter/login.md +++ b/docs/document/flutter/login.md @@ -4,21 +4,15 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -示例代码如下所示: - -```dart -try { - await EMClient.getInstance.createAccount(userId, password); -} on EMError catch (e) {} -``` +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 diff --git a/docs/document/harmonyos/login.md b/docs/document/harmonyos/login.md index 63497cef7..dd9627103 100644 --- a/docs/document/harmonyos/login.md +++ b/docs/document/harmonyos/login.md @@ -4,21 +4,15 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: + +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 - 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -示例代码如下所示: - -```typescript -ChatClient.getInstance().createAccount(userId, pwd).then(()=> { - // success logic -}); -``` - -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 diff --git a/docs/document/ios/login.md b/docs/document/ios/login.md index e7a7e9ff3..2c5f13d8b 100644 --- a/docs/document/ios/login.md +++ b/docs/document/ios/login.md @@ -4,22 +4,15 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: + +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 - 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -示例代码如下所示: - -```swift -// 异步方法 -EMClient.shared.register(withUsername: "userId", password: "your password") { userId, e in - -} -``` - -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 diff --git a/docs/document/react-native/login.md b/docs/document/react-native/login.md index e73d0cb49..5446c1577 100644 --- a/docs/document/react-native/login.md +++ b/docs/document/react-native/login.md @@ -4,26 +4,15 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 - -示例代码如下所示: - -```typescript -ChatClient.getInstance() - .createAccount(username, password) - .then((value: any) => { - console.log("createAccount: success", value); - }) - .catch((reason: any) => { - console.log("createAccount: fail", reason); - }); -``` +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 + +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 diff --git a/docs/document/server-side/account_system.md b/docs/document/server-side/account_system.md index 2dd1c3455..4532e501d 100644 --- a/docs/document/server-side/account_system.md +++ b/docs/document/server-side/account_system.md @@ -1525,7 +1525,7 @@ GET https://{host}/{org_name}/{app_name}/users/{username}/resources ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'http://XXXX/XXXX/XXXX/users/XXXX/resources' \ +curl -X GET 'http://XXXX/XXXX/XXXX/users/XXXX/resources' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ' ``` diff --git a/docs/document/server-side/chatroom_manage.md b/docs/document/server-side/chatroom_manage.md index be8a5275f..72eb27fe9 100644 --- a/docs/document/server-side/chatroom_manage.md +++ b/docs/document/server-side/chatroom_manage.md @@ -123,7 +123,7 @@ GET https://{host}/{org_name}/{app_name}/chatrooms?limit={N}&cursor={cursor} ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'https://XXXX/XXXX/XXXX/chatrooms?limit=10' \ +curl -X GET 'https://XXXX/XXXX/XXXX/chatrooms?limit=10' \ --header 'Authorization: Bearer ' ``` diff --git a/docs/document/server-side/chatroom_superadmin.md b/docs/document/server-side/chatroom_superadmin.md index 86560c455..cd433298b 100644 --- a/docs/document/server-side/chatroom_superadmin.md +++ b/docs/document/server-side/chatroom_superadmin.md @@ -298,7 +298,7 @@ DELETE https://{host}/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin} ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'https://XXXX/XXXX/XXXX/chatrooms/super_admin/XXXX' +curl -X DELETE 'https://XXXX/XXXX/XXXX/chatrooms/super_admin/XXXX' --header 'Authorization: Bearer ' ``` diff --git a/docs/document/server-side/conversation_delete.md b/docs/document/server-side/conversation_delete.md index 5560c3ad7..68caf215b 100644 --- a/docs/document/server-side/conversation_delete.md +++ b/docs/document/server-side/conversation_delete.md @@ -79,7 +79,7 @@ DELETE https://{host}/{org_name}/{app_name}/users/{username}/user_channel ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'https://XXXX/XXXX/XXXX/users/u1/user_channel' \ +curl -X DELETE 'https://XXXX/XXXX/XXXX/users/u1/user_channel' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ diff --git a/docs/document/server-side/group_manage.md b/docs/document/server-side/group_manage.md index 7a8aa6123..0d663a5f1 100644 --- a/docs/document/server-side/group_manage.md +++ b/docs/document/server-side/group_manage.md @@ -642,7 +642,7 @@ GET https://{host}/{org_name}/{app_name}/chatgroups/user/{username}?pagesize={}& ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'http://XXXX/XXXX/XXXX/chatgroups/user/XXXX' \ +curl -X GET 'http://XXXX/XXXX/XXXX/chatgroups/user/XXXX' \ -H 'Authorization: Bearer ' ``` diff --git a/docs/document/server-side/group_member_attribute.md b/docs/document/server-side/group_member_attribute.md index 3bd4b25ae..3f2f7c302 100644 --- a/docs/document/server-side/group_member_attribute.md +++ b/docs/document/server-side/group_member_attribute.md @@ -101,7 +101,7 @@ PUT https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{use ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X PUT 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/user/XXXX' \ +curl -X PUT 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/user/XXXX' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ' \ @@ -193,7 +193,7 @@ PUT https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/users/bat ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X PUT 'http://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/users/batch' \ +curl -X PUT 'http://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/users/batch' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ' \ @@ -305,7 +305,7 @@ GET https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{use ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'https://a1-hsb.easemob.com/easemob-demo/testy/metadata/chatgroup/207059303858177/user/test2' \ +curl -X GET 'https://a1-hsb.easemob.com/easemob-demo/testy/metadata/chatgroup/207059303858177/user/test2' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' -H 'Authorization: Bearer YWMtozZwfsFFEe2oQTE6aob5eQAAAAAAAAAAAAAAAAAAAAExCXvf5bRGAJBgXNYFJVQ9AQMAAAGG2MUClwBPGgDsI1GYg1QtapTEdGyrm29Eu6L8qx60lDZ9TJRDOQjEsw' \ @@ -389,7 +389,7 @@ POST https://{host}/{org_name}/{app_name}/metadata/chatgroup/{group_id}/get ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X POST 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/get'\ +curl -X POST 'https://XXXX/XXXX/XXXX/metadata/chatgroup/XXXX/get'\ -H'Content-Type: application/json'\ -H'Accept: application/json'\ -H'Authorization: Bearer '\ diff --git a/docs/document/server-side/message_attachment_storage.md b/docs/document/server-side/message_attachment_storage.md index 3ea707b53..4c88da46d 100644 --- a/docs/document/server-side/message_attachment_storage.md +++ b/docs/document/server-side/message_attachment_storage.md @@ -83,7 +83,7 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/chatfiles/lifetime ```shell # 将 替换为你的用户 Token -curl -X PUT -L "http://localhost/{org}/{app}/users/{username}/chatfiles/lifetime" \ +curl -X PUT "http://localhost/{org}/{app}/users/{username}/chatfiles/lifetime" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer " \ -d '{ diff --git a/docs/document/server-side/message_broadcast.md b/docs/document/server-side/message_broadcast.md index 817c799e8..3bebea6de 100644 --- a/docs/document/server-side/message_broadcast.md +++ b/docs/document/server-side/message_broadcast.md @@ -78,7 +78,7 @@ POST https://{host}/{org_name}/{app_name}/messages/broadcast ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -100,7 +100,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -128,7 +128,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -153,7 +153,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -181,7 +181,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -205,7 +205,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -229,7 +229,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -251,7 +251,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -373,7 +373,7 @@ POST https://{host}/{org_name}/{app_name}/messages/users/broadcast ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -393,7 +393,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -419,7 +419,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -442,7 +442,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -467,7 +467,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -489,7 +489,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -511,7 +511,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -531,7 +531,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -659,7 +659,7 @@ POST https://{host}/{org_name}/{app_name}/messages/chatrooms/broadcast ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -680,7 +680,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -707,7 +707,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -731,7 +731,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -757,7 +757,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -780,7 +780,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -803,7 +803,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -824,7 +824,7 @@ curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ ```bash # 将 替换为你在服务端生成的 App Token -curl -L 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/chatrooms/broadcast' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ diff --git a/docs/document/server-side/message_delete.md b/docs/document/server-side/message_delete.md index 8df049064..35a12ad07 100644 --- a/docs/document/server-side/message_delete.md +++ b/docs/document/server-side/message_delete.md @@ -109,7 +109,7 @@ DELETE https://{host}/{org_name}/{app_name}/rest/message/roaming/chat/user/{user ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'https://XXXX/XXXX/XXXX/rest/message/roaming/chat/user/XXXX?userId=XXXX&msgIdList=XXXX&isNotify=false' \ +curl -X DELETE 'https://XXXX/XXXX/XXXX/rest/message/roaming/chat/user/XXXX?userId=XXXX&msgIdList=XXXX&isNotify=false' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' @@ -199,7 +199,7 @@ DELETE https://{host}/{org_name}/{app_name}/rest/message/roaming/group/user/{use ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'https://XXXX/XXXX/XXXX/rest/message/roaming/group/user/XXXX?groupId=XXXX&msgIdList=XXXXisNotify=false' \ +curl -X DELETE 'https://XXXX/XXXX/XXXX/rest/message/roaming/group/user/XXXX?groupId=XXXX&msgIdList=XXXXisNotify=false' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' @@ -275,7 +275,7 @@ POST https://{host}/{org_name}/{app_name}/rest/message/roaming/user/{userId}/del ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X POST 'https://XXXX/XXXX/XXXX/rest/message/roaming/user/XXXX/delete/all' \ +curl -X POST 'https://XXXX/XXXX/XXXX/rest/message/roaming/user/XXXX/delete/all' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: Content-Type: application/json' \ -H 'Accept: Accept: application/json' @@ -362,7 +362,7 @@ DELETE https://{host}/{org_name}/{app_name}/rest/message/roaming/chat/user/{user ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'http://XXXX/XXXX/XXXX/rest/message/roaming/chat/user/XXXX/time?userId=XXXX&delTime=1659014868000&isNotify=false' \ +curl -X DELETE 'http://XXXX/XXXX/XXXX/rest/message/roaming/chat/user/XXXX/time?userId=XXXX&delTime=1659014868000&isNotify=false' \ -H 'Authorization: Bearer ' ``` @@ -447,7 +447,7 @@ DELETE https://{host}/{org_name}/{app_name}/rest/message/roaming/group/user/{use ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'http://XXXX/XXXX/XXXX/rest/message/roaming/group/user/XXXX/time?groupId=XXXX&delTime=1659014868000&isNotify=false' \ +curl -X DELETE 'http://XXXX/XXXX/XXXX/rest/message/roaming/group/user/XXXX/time?groupId=XXXX&delTime=1659014868000&isNotify=false' \ -H 'Authorization: Bearer ' ``` diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index 938e9de48..10ed8ffad 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -108,7 +108,7 @@ PUT https://{host}/{org_name}/{app_name}/users/{userId}/push/binding **绑定请求** ```shell -curl -L -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ +curl -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -121,7 +121,7 @@ curl -L -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ **解除绑定** ```shell -curl -L -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ +curl -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ @@ -208,7 +208,7 @@ GET https://{host}/{org_name}/{app_name}/users/{userId}/push/binding #### 请求示例 ```shell -curl -L -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ +curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/push/binding' \ -H 'Authorization: Bearer ' ``` @@ -596,7 +596,7 @@ PUT https://{host}/{org}/{app}/users/{userId}/notification/{chattype}/{key} ```bash // 你需要将 替换为你的用户 Token -curl -L -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/notification/user/XXXX' \ +curl -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/notification/user/XXXX' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ @@ -681,7 +681,7 @@ GET https://{host}/{org}/{app}/users/{userId}/notification/{chattype}/{key} ```bash // 请将 替换为你的用户 Token -curl -L -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/chatgroup/XXXX' \ +curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/chatgroup/XXXX' \ -H 'Authorization: Bearer ' ``` @@ -758,7 +758,7 @@ PUT https://{host}/{org}/{app}/users/{userId}/notification/language #### 请求示例 ```bash -curl -L -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ +curl -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ @@ -830,7 +830,7 @@ GET https://{host}/{org_name}/{app_name}/users/{userId}/notification/language #### 请求示例 ```bash -curl -L -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ +curl -X GET 'https://XXXX/XXXX/XXXX/users/XXXX/notification/language' \ -H 'Authorization: Bearer ' ``` @@ -1189,7 +1189,7 @@ curl -X PUT 'https://XXXX/XXXX/XXXX/users/XXXX/notification/template' \ 关于推送标题和推送内容参数的填充,即 `title_pattern` 和 `content_pattern`,详见[创建离线推送模板](#创建离线推送模板)。 ```shell -curl -L -X POST 'https://XXXX/XXXX/XXXX/messages/users' \ +curl -X POST 'https://XXXX/XXXX/XXXX/messages/users' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ diff --git a/docs/document/server-side/push_result_statistics.md b/docs/document/server-side/push_result_statistics.md index 44d6d2d59..2c53df1fe 100644 --- a/docs/document/server-side/push_result_statistics.md +++ b/docs/document/server-side/push_result_statistics.md @@ -72,7 +72,7 @@ GET https://{host}/{org_name}/{app_name}/push/data/offline-push/begin/{startTime ```shell 将 替换为你在服务端生成的 App Token -curl -L -g -X GET 'https://XXXX/XXXX/XXXX/push/data/offline-push/begin/2024-04-01/end/2024-04-02?platform=ALL' \ +curl -g -X GET 'https://XXXX/XXXX/XXXX/push/data/offline-push/begin/2024-04-01/end/2024-04-02?platform=ALL' \ -H 'Authorization: Bearer ``` diff --git a/docs/document/server-side/user_global_mute.md b/docs/document/server-side/user_global_mute.md index b86d5f579..c441452c6 100644 --- a/docs/document/server-side/user_global_mute.md +++ b/docs/document/server-side/user_global_mute.md @@ -116,7 +116,7 @@ POST https://{host}/{org_name}/{app_name}/mutes ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X POST 'https://XXXX/XXXX/XXXX/mutes' \ +curl -X POST 'https://XXXX/XXXX/XXXX/mutes' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ @@ -214,7 +214,7 @@ GET https://{host}/{org_name}/{app_name}/mutes/{username} ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'https://XXXX/XXXX/XXXX/mutes/zs1' \ +curl -X GET 'https://XXXX/XXXX/XXXX/mutes/zs1' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ @@ -313,7 +313,7 @@ GET https://{host}/{org_name}/{app_name}/mutes ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'https://XXXX/XXXX/XXXX/mutes?pageNum=1&pageSize=10' \ +curl -X GET 'https://XXXX/XXXX/XXXX/mutes?pageNum=1&pageSize=10' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ diff --git a/docs/document/server-side/user_relationship.md b/docs/document/server-side/user_relationship.md index 85ae7f168..795094287 100644 --- a/docs/document/server-side/user_relationship.md +++ b/docs/document/server-side/user_relationship.md @@ -413,7 +413,7 @@ GET https://{host}/{org_name}/{app_name}/user/{username}/contacts?limit={N}&curs ```shell # 将 替换为你在服务端生成的 App Token -curl -L -X GET 'https://XXXX/XXXX/XXXX/user/XXXX/contacts?limit=10&needReturnRemark=true' \ +curl -X GET 'https://XXXX/XXXX/XXXX/user/XXXX/contacts?limit=10&needReturnRemark=true' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer ' diff --git a/docs/document/unity/login.md b/docs/document/unity/login.md index c49d4cb85..342124cc7 100644 --- a/docs/document/unity/login.md +++ b/docs/document/unity/login.md @@ -4,36 +4,21 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 - -示例代码如下所示: - -```csharp -SDKClient.Instance.CreateAccount(username, password, - callback: new CallBack( - - onSuccess: () => { - Debug.Log("CreateAccount succeed"); - }, +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 - onError: (code, desc) => { - Debug.Log($"CreateAccount failed, code: {code} ; desc: {desc}"); - } - ) -); -``` - -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 + +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下,你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下,你在[环信控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 在生产环境中,为了安全考虑,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。 diff --git a/docs/document/web/login.md b/docs/document/web/login.md index 241f1b91a..b9efd9335 100644 --- a/docs/document/web/login.md +++ b/docs/document/web/login.md @@ -4,30 +4,23 @@ ## 用户注册 -用户注册支持以下方式: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信云控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 -示例代码如下所示: - -```javascript -conn.registerUser({ - username: "user1", - password: "xxx", -}); -``` +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在 [环信控制台](https://console.easemob.com/user/login) 创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 登录方式 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下,你在 [环信即时通讯云控制台](https://console.easemob.com/user/login) 创建用户后,环信服务器会自动为这些用户分配用户 Token,详见 [创建用户的介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +测试环境下,你在 [环信控制台](https://console.easemob.com/user/login) 创建用户后,环信服务器会自动为这些用户分配用户 Token,详见 [创建用户的介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 -在生产环境中,为了安全考虑,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%(4.15.0 之前为 50%)时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token,例如,每次登录时更新 token。 +在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。SDK 会在 Token 过期时或者其有效期达到 80%(4.15.0 之前为 50%)时分别回调 `onTokenExpired` 和 `onTokenWillExpire` 通知用户更新 Token。你可以采取各种机制更新 Token,例如,每次登录时更新 token。 ```javascript conn diff --git a/docs/document/windows/login.md b/docs/document/windows/login.md index 9ba0f6f3b..f1f5af8b3 100644 --- a/docs/document/windows/login.md +++ b/docs/document/windows/login.md @@ -4,38 +4,23 @@ ## 用户注册 -用户注册模式分为以下两种: +1. 可通过以下两种方式调用接口创建用户: -- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 - -示例代码如下所示: - -```csharp -SDKClient.Instance.CreateAccount(username, password, - callback: new CallBack( - - onSuccess: () => { - Debug.Log("CreateAccount succeed"); - }, +- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在 [环信控制台](https://console.easemob.com/user/login) 的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见 [授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户) 和 [批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户) 的接口介绍。 - onError: (code, desc) => { - Debug.Log($"CreateAccount failed, code: {code} ; desc: {desc}"); - } - ) -); -``` +- 开放注册:一般在体验 Demo 和测试环境时使用,正式环境中不推荐使用该方式注册环信账号。要使用开放注册,需要在 [环信控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**开放注册**。只有打开该开关,才能使用客户端或 [REST API](/document/server-side/account_system.html#开放注册单个用户)开放注册用户。 -- 授权注册:通过环信提供的 REST API 注册环信用户账号,注册后保存到你的服务器或返给客户端。要使用授权注册,你需要在[环信即时通讯云控制台](https://console.easemob.com/user/login)的**即时通讯** > **服务概览**的**设置**区域,将**用户注册模式**设置为**授权注册**。相关的 REST API 介绍,详见[授权注册单个用户](/document/server-side/account_system.html#授权注册单个用户)和[批量授权注册用户](/document/server-side/account_system.html#批量授权注册用户)的接口介绍。 +2. 通过 [环信控制台](https://console.easemob.com/user/login) 创建用户: -除此以外,可以在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见[创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 +可以在[环信控制台](https://console.easemob.com/user/login)创建正式环境下和测试环境下的用户,详见 [创建用户相关介绍](/product/enable_and_configure_IM.html#创建-im-用户)。 ## 主动登录 1. **用户 ID + token** 是更加安全的登录方式。 -测试环境下,你在[环信即时通讯云控制台](https://console.easemob.com/user/login)创建用户后,环信服务器会自动为这些用户分配用户 Token,详见[测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 +测试环境下,你在 [环信控制台](https://console.easemob.com/user/login) 创建用户后,环信服务器会自动为这些用户分配用户 Token,详见 [测试环境下创建用户的介绍](/product/enable_and_configure_IM.html#测试环境)。 -在生产环境中,为了安全考虑,你需要在你的应用服务器集成[获取 App Token API](/document/server-side/easemob_app_token.html) 和[获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。 +在生产环境中,为了安全考虑,你需要在你的应用服务器集成 [获取 App Token API](/document/server-side/easemob_app_token.html) 和 [获取用户 Token API](/document/server-side/easemob_user_token.html) 实现获取 Token 的业务逻辑,使你的用户从你的应用服务器获取 Token。 使用 token 登录时需要处理 token 过期的问题,比如在每次登录时更新 token 等机制。 diff --git a/docs/product/demo.md b/docs/product/demo.md index 645203e70..9940c1883 100644 --- a/docs/product/demo.md +++ b/docs/product/demo.md @@ -25,29 +25,35 @@ :xl="6" :lg="6" > - + - - + - - - + + + + | 客户端 | 新 Demo | 旧 Demo | | :------------- | :----- | :----- | -| Android | Kotlin Demo,v4.6.0 及以上 |
- Java Demo,v4.5.0 及以下
- 查看 [Demo 源码地址](https://github.com/easemob/chat-android),环信不再维护该 Demo 源码 | -| iOS | Swift Demo,v4.6.0 及以上 |
- Objective-C Demo,4.5.0 及以下。
- 查看 [Demo 源码地址](https://github.com/easemob/easemob-demo-ios/tree/OCDemo),环信不再维护该 Demo 源码 | -| Web | Vue 3 Demo | Vue 2 Demo
-可查看 [Demo 源码地址](https://github.com/easemob/webim-vue-demo/tree/dev-4.0),环信不再维护该 Demo 源码| +| Android |
- Kotlin Demo,v4.6.0 及以上
- 查看 [Demo 源码地址](https://github.com/easemob/easemob-demo-android) |
- Java Demo,v4.5.0 及以下
- 查看 [Demo 源码地址](https://github.com/easemob/chat-android),环信不再维护该 Demo 源码 | +| iOS |
- Swift Demo,v4.6.0 及以上
- 查看 [Demo 源码地址](https://github.com/easemob/easemob-demo-ios) |
- Objective-C Demo,4.5.0 及以下。
- 查看 [Demo 源码地址](https://github.com/easemob/easemob-demo-ios/tree/OCDemo),环信不再维护该 Demo 源码 | +| Web |
- React Demo
- 可查看 [Demo 源码地址](https://github.com/easemob/easemob-demo-react/tree/dev_4.0) | | +| Web |
- Vue 3 Demo
- 可查看 [Demo 源码地址](https://github.com/easemob/webim-vue-demo/tree/demo-vue3) | Vue 2 Demo
-可查看 [Demo 源码地址](https://github.com/easemob/webim-vue-demo/tree/dev-4.0),环信不再维护该 Demo 源码| ## Uni-app Demo @@ -78,6 +84,19 @@ +## 微信小程序 + + + + + + + ## Flutter Demo @@ -99,7 +118,7 @@ -## React Native/React Demo +## React Native Demo - - - - - + diff --git a/docs/push/push_by_tag.md b/docs/push/push_by_tag.md index afee21f40..e27a59587 100644 --- a/docs/push/push_by_tag.md +++ b/docs/push/push_by_tag.md @@ -85,7 +85,7 @@ POST https://{host}/{org_name}/{app_name}/push/label ```shell 将 替换为你在服务端生成的 App Token -curl -L -X POST 'localhost/hx/hxdemo/push/label' \ +curl -X POST 'localhost/hx/hxdemo/push/label' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ @@ -156,7 +156,7 @@ GET https://{host}/{org_name}/{app_name}/push/label/{labelname} ```shell 将 替换为你在服务端生成的 App Token -curl -L -X GET 'localhost/hx/hxdemo/push/label/90' \ +curl -X GET 'localhost/hx/hxdemo/push/label/90' \ -H 'Authorization: Bearer ' ``` @@ -226,7 +226,7 @@ GET https://{host}/{org_name}/{app_name}/push/label ```shell 将 替换为你在服务端生成的 App Token -curl -L -X GET 'localhost/hx/hxdemo/push/label' \ +curl -X GET 'localhost/hx/hxdemo/push/label' \ -H 'Authorization: Bearer ' ``` @@ -297,7 +297,7 @@ DELETE https://{host}/{org_name}/{app_name}/push/label/{labelname} ```shell 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'localhost/hx/hxdemo/push/label/post-90s' \ +curl -X DELETE 'localhost/hx/hxdemo/push/label/post-90s' \ -H 'Authorization: Bearer ' ``` @@ -364,7 +364,7 @@ POST https://{host}/{org_name}/{app_name}/push/label/{labelname}/user ```shell 将 替换为你在服务端生成的 App Token -curl -L -X POST 'localhost/hx/hxdemo/push/label/post-90s/user' \ +curl -X POST 'localhost/hx/hxdemo/push/label/post-90s/user' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ @@ -436,7 +436,7 @@ GET https://{host}/{org_name}/{app_name}/push/label/{labelname}/user/{username} ```shell 将 替换为你在服务端生成的 App Token -curl -L -X GET 'localhost/hx/hxdemo/push/label/post-90s/user/hx1' \ +curl -X GET 'localhost/hx/hxdemo/push/label/post-90s/user/hx1' \ -H 'Authorization: Bearer ' ``` @@ -508,7 +508,7 @@ GET https://{host}/{org_name}/{app_name}/push/label/{labelname}/user ```shell 将 替换为你在服务端生成的 App Token -curl -L -X GET 'localhost/hx/hxdemo/push/label/post-90s/user?limit=1' \ +curl -X GET 'localhost/hx/hxdemo/push/label/post-90s/user?limit=1' \ -H 'Authorization: Bearer ' ``` @@ -581,7 +581,7 @@ DELETE https://{host}/{org_name}/{app_name}/push/label/{labelname}/user ```shell 将 替换为你在服务端生成的 App Token -curl -L -X DELETE 'localhost/hx/hxdemo/push/label/post-90s/user' \ +curl -X DELETE 'localhost/hx/hxdemo/push/label/post-90s/user' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{ diff --git a/docs/push/push_send_notification.md b/docs/push/push_send_notification.md index bab7e03c5..12e080b7d 100644 --- a/docs/push/push_send_notification.md +++ b/docs/push/push_send_notification.md @@ -387,7 +387,7 @@ POST https://{host}/{org_name}/{app_name}/push/list/label ```shell 将 替换为你在服务端生成的 App Token -curl -L -X POST 'http://a1.easemob.com/easemob/easeim/push/list/label' \ +curl -X POST 'http://a1.easemob.com/easemob/easeim/push/list/label' \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -d '{