From 7b2e2188c7277cef7227e961782df75709482c8c Mon Sep 17 00:00:00 2001 From: haoxiuwen Date: Tue, 31 Dec 2024 18:25:31 +0800 Subject: [PATCH] Modify IM Docs --- docs/document/applet/uniappnativeapp.md | 3 ++- .../server-side/message_attachment_storage.md | 24 +++++++++++++++---- docs/document/server-side/push.md | 2 +- 3 files changed, 23 insertions(+), 6 deletions(-) diff --git a/docs/document/applet/uniappnativeapp.md b/docs/document/applet/uniappnativeapp.md index c97714d2..bd1f5f41 100644 --- a/docs/document/applet/uniappnativeapp.md +++ b/docs/document/applet/uniappnativeapp.md @@ -12,7 +12,8 @@ :::tip - Demo 只包含部分 IM 功能，详细参考 **功能说明** -- Uni-app Demo Git 源码地址 [https://github.com/easemob/webim-uniapp-demo](https://github.com/easemob/webim-uniapp-demo)::: +- Uni-app Demo Git 源码地址 [https://github.com/easemob/webim-uniapp-demo](https://github.com/easemob/webim-uniapp-demo) +::: ## 功能说明 diff --git a/docs/document/server-side/message_attachment_storage.md b/docs/document/server-side/message_attachment_storage.md index c6815008..d84df1e0 100644 --- a/docs/document/server-side/message_attachment_storage.md +++ b/docs/document/server-side/message_attachment_storage.md @@ -10,6 +10,21 @@ **调用频率**：100 次/秒/App Key +## 前提条件 + +要调用环信即时通讯 REST API，请确保满足以下要求： + +- 已在环信即时通讯控制台 [开通配置环信即时通讯 IM 服务](enable_and_configure_IM.html)。 +- 了解环信 IM REST API 的调用频率限制，详见 [接口频率限制](limitationapi.html)。 + +## 认证方式 + +环信即时通讯 REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，必须在请求头部填入如下 `Authorization` 字段： + +`Authorization: Bearer YourAppToken` + +为提高项目的安全性，环信使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 REST API 仅支持使用 App Token 的鉴权方式，详见 [使用 App Token 鉴权](easemob_app_token.html)。 + #### HTTP 请求 ```http @@ -18,12 +33,13 @@ POST https://{host}/{org_name}/{app_name}/users/{username}/chatfiles/lifetime ##### 路径参数 -| 参数 | 类型 | 是否必需 | 描述 | -| :--------- | :----- | :------- | :------------------------- | +| 参数 | 类型 | 是否必需 | 描述 | +| :--------- | :----- | :------- | :--------------- | +| `host` | String | 是 | 环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `org_name` | String | 是 | 环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | +| `app_name` | String | 是 | 你在环信即时通讯云控制台创建应用时填入的应用名称。详见 [获取环信即时通讯 IM 的信息](enable_and_configure_IM.html#获取环信即时通讯-im-的信息)。 | | `username` | String | 是 | 调用该接口的用户 ID。 | -其他参数及说明详见 [公共参数](#公共参数)。 - ##### 请求 Header | 参数 | 类型 | 是否必需 | 描述 | diff --git a/docs/document/server-side/push.md b/docs/document/server-side/push.md index e95de3c7..bcc29bc9 100644 --- a/docs/document/server-side/push.md +++ b/docs/document/server-side/push.md @@ -357,7 +357,7 @@ PUT https://{host}/{org_name}/{app_name}/push/nickname 如果返回的 HTTP 状态码为 `200`，表示请求成功，响应包体中包含以下字段： | 参数 | 类型 | 描述 | -| :-------------- | :----- | :------- | :----------------------------------------------------------- | +| :-------------- | :----- | :------- | | `entities` | JSON Array | 用户在推送通知中显示的昵称以及用户相关信息。 | | `entities.push_nickname` | String | 离线推送时在接收方的客户端推送通知栏中显示的发送方的昵称。 | | `entities.username` | String | 为哪个用户设置离线推送时显示的发送方昵称。 |