docs: update request url contents. (#170)

mo3et · web-flow · commit 0f417627ef3c · 2024-09-23T18:46:43.000+08:00
diff --git a/docs/restapi/apis/authenticationManagement/getToken.mdx b/docs/restapi/apis/authenticationManagement/getToken.mdx
@@ -1,12 +1,12 @@
 ---
-sidebar_position: 2
-title: 以secret获取token
+sidebar_position: 1
+title: 获取用户token
 hide_title: true
 ---
 
 <center>
 
-## 以 secret 获取 token
+## 获取用户 token
 
 </center>
 
@@ -26,8 +26,8 @@ hide_title: true
 
 ### Header
 
-| header 名   | 示例值        | 选填 | 类型   | 说明                         |
-| :---------- | :------------ | :--- | ------ | ---------------------------- |
+| header 名   | 示例值        | 选填 | 类型   | 说明                                               |
+| :---------- | :------------ | :--- | ------ | -------------------------------------------------- |
 | operationID | 1646445464564 | 必填 | string | 用于全局链路追踪，建议使用时间戳，在每个请求中独立 |
 
 ### 请求参数示例
@@ -65,8 +65,8 @@ hide_title: true
 | 参数名            | 类型   | 说明                         |
 | :---------------- | :----- | :--------------------------- |
 | errCode           | int    | 错误码,0 表示成功            |
-| errMsg            | string | 错误简要信息，为空    |
-| errDlt            | errDlt | 错误详细信息，为空    |
+| errMsg            | string | 错误简要信息，为空           |
+| errDlt            | errDlt | 错误详细信息，为空           |
 | data              | object | 通用数据对象，具体结构见下方 |
 | token             | string | 获取到的用户 token           |
 | expireTimeSeconds | string | token 的过期时间（单位秒）   |
diff --git a/docs/restapi/apis/authenticationManagement/getUserToken.mdx b/docs/restapi/apis/authenticationManagement/getUserToken.mdx
@@ -1,12 +1,12 @@
 ---
-sidebar_position: 1
-title: 获取普通用户token
+sidebar_position: 2
+title: 管理员获取用户token
 hide_title: true
 ---
 
 <center>
 
-## 获取普通用户 token
+## 管理员获取用户 token
 
 </center>
 
diff --git a/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx b/docs/restapi/apis/conversationManagement/getOwnerConversation.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/conversation/get_owner_conversation` 
+- `{API_ADDRESS}/conversation/get_owner_conversation` 
 
 ### Header
 
diff --git a/docs/restapi/apis/conversationManagement/getSortedConversationList.mdx b/docs/restapi/apis/conversationManagement/getSortedConversationList.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post`
 ### 请求URL
-- `http://x.x.x.x:10002/conversation/get_sorted_conversation_list`
+- `{API_ADDRESS}/conversation/get_sorted_conversation_list`
 
 ### Header
 
diff --git a/docs/restapi/apis/conversationManagement/setConversations.mdx b/docs/restapi/apis/conversationManagement/setConversations.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/conversation/set_conversations` 
+- `{API_ADDRESS}/conversation/set_conversations` 
 
 
 ### Header
diff --git a/docs/restapi/apis/friendsManagement/addBlackList.mdx b/docs/restapi/apis/friendsManagement/addBlackList.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 21
 title: 添加黑名单
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/checkFriend.mdx b/docs/restapi/apis/friendsManagement/checkFriend.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 14
 title: 检查好友关系
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/deleteBlackList.mdx b/docs/restapi/apis/friendsManagement/deleteBlackList.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 22
 title: 移除黑名单
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/deleteFriend.mdx b/docs/restapi/apis/friendsManagement/deleteFriend.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 15
 title: 删除好友
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/getBlackList.mdx b/docs/restapi/apis/friendsManagement/getBlackList.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 14
+sidebar_position: 20
 title: 获取黑名单列表
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/getFriendList.mdx b/docs/restapi/apis/friendsManagement/getFriendList.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 15
 title: 获取好友列表
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/getRecvApplication.mdx b/docs/restapi/apis/friendsManagement/getRecvApplication.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 17
 title: 获取收到的好友申请
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/getSentApplication.mdx b/docs/restapi/apis/friendsManagement/getSentApplication.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 16
 title: 获取发起的好友申请
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/processApplication.mdx b/docs/restapi/apis/friendsManagement/processApplication.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 19
 title: 处理好友申请
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/sendApplication.mdx b/docs/restapi/apis/friendsManagement/sendApplication.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 18
 title: 发起好友申请
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/setFriendRemark.mdx b/docs/restapi/apis/friendsManagement/setFriendRemark.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 9
+sidebar_position: 12
 title: 修改好友备注
 hide_title: true
 ---
diff --git a/docs/restapi/apis/friendsManagement/updateFriends.mdx b/docs/restapi/apis/friendsManagement/updateFriends.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 13
 title: 修改好友信息
 hide_title: true
 ---
diff --git a/docs/restapi/apis/groupManagement/cancelMuteGroup.mdx b/docs/restapi/apis/groupManagement/cancelMuteGroup.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/cancel_mute_group` 
+- `{API_ADDRESS}/group/cancel_mute_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/cancelMuteGroupMember.mdx b/docs/restapi/apis/groupManagement/cancelMuteGroupMember.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/cancel_mute_group_member` 
+- `{API_ADDRESS}/group/cancel_mute_group_member` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/createGroup.mdx b/docs/restapi/apis/groupManagement/createGroup.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/create_group` 
+- `{API_ADDRESS}/group/create_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/dismissGroup.mdx b/docs/restapi/apis/groupManagement/dismissGroup.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 14
 title: 解散群
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/dismiss_group` 
+- `{API_ADDRESS}/group/dismiss_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getGroupApplicationListByUserID.mdx b/docs/restapi/apis/groupManagement/getGroupApplicationListByUserID.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_group_users_req_application_list` 
+- `{API_ADDRESS}/group/get_group_users_req_application_list` 
 
 ### Header
 
diff --git a/docs/restapi/apis/groupManagement/getGroupMemberList.mdx b/docs/restapi/apis/groupManagement/getGroupMemberList.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 7
+sidebar_position: 5
 title: 获取群成员列表
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_group_member_list` 
+- `{API_ADDRESS}/group/get_group_member_list` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getGroupMembersInfo.mdx b/docs/restapi/apis/groupManagement/getGroupMembersInfo.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_group_members_info` 
+- `{API_ADDRESS}/group/get_group_members_info` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getGroupsInfo.mdx b/docs/restapi/apis/groupManagement/getGroupsInfo.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_groups_info` 
+- `{API_ADDRESS}/group/get_groups_info` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getJoinedGroupList.mdx b/docs/restapi/apis/groupManagement/getJoinedGroupList.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_joined_group_list` 
+- `{API_ADDRESS}/group/get_joined_group_list` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getRecvGroupApplicationList.mdx b/docs/restapi/apis/groupManagement/getRecvGroupApplicationList.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_recv_group_applicationList` 
+- `{API_ADDRESS}/group/get_recv_group_applicationList` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/getUserReqGroupApplicationList.mdx b/docs/restapi/apis/groupManagement/getUserReqGroupApplicationList.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/get_user_req_group_applicationList` 
+- `{API_ADDRESS}/group/get_user_req_group_applicationList` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/groupApplicationResponse.mdx b/docs/restapi/apis/groupManagement/groupApplicationResponse.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/group_application_response` 
+- `{API_ADDRESS}/group/group_application_response` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/inviteUserToGroup.mdx b/docs/restapi/apis/groupManagement/inviteUserToGroup.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/invite_user_to_group` 
+- `{API_ADDRESS}/group/invite_user_to_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/joinGroup.mdx b/docs/restapi/apis/groupManagement/joinGroup.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 15
+sidebar_position: 3
 title: 申请入群
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/join_group` 
+- `{API_ADDRESS}/group/join_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/kickGroup.mdx b/docs/restapi/apis/groupManagement/kickGroup.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 5
+sidebar_position: 15
 title: 移除群成员
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/kick_group` 
+- `{API_ADDRESS}/group/kick_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/muteGroup.mdx b/docs/restapi/apis/groupManagement/muteGroup.mdx
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/mute_group` 
+- `{API_ADDRESS}/group/mute_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/muteGroupMember.mdx b/docs/restapi/apis/groupManagement/muteGroupMember.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 22
+sidebar_position: 12
 title: 禁言群成员
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/mute_group_member` 
+- `{API_ADDRESS}/group/mute_group_member` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/quitGroup.mdx b/docs/restapi/apis/groupManagement/quitGroup.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 18
+sidebar_position: 4
 title: 退出群组
 hide_title: true
 ---
@@ -15,7 +15,7 @@ hide_title: true
 ### 请求方式
 - `post` 
 ### 请求URL
-- `http://x.x.x.x:10002/group/quit_group` 
+- `{API_ADDRESS}/group/quit_group` 
 
 
 ### Header
diff --git a/docs/restapi/apis/groupManagement/setGroupInfo.mdx b/docs/restapi/apis/groupManagement/setGroupInfo.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 17
+sidebar_position: 8
 title: 修改群组信息
 hide_title: true
 ---
@@ -19,7 +19,7 @@ hide_title: true
 
 ### 请求 URL
 
-- `http://x.x.x.x:10002/group/set_group_info_ex`
+- `{API_ADDRESS}/group/set_group_info_ex`
 
 ### Header
 
diff --git a/docs/restapi/apis/groupManagement/setGroupMemberInfo.mdx b/docs/restapi/apis/groupManagement/setGroupMemberInfo.mdx
diff --git a/docs/restapi/apis/groupManagement/transferGroup.mdx b/docs/restapi/apis/groupManagement/transferGroup.mdx
diff --git a/docs/restapi/apis/messageManagement/batchSendMessage.mdx b/docs/restapi/apis/messageManagement/batchSendMessage.mdx
diff --git a/docs/restapi/apis/messageManagement/deleteUserAllMessage.mdx b/docs/restapi/apis/messageManagement/deleteUserAllMessage.mdx
diff --git a/docs/restapi/apis/messageManagement/revokeMessage.mdx b/docs/restapi/apis/messageManagement/revokeMessage.mdx
diff --git a/docs/restapi/apis/messageManagement/sendMessage.mdx b/docs/restapi/apis/messageManagement/sendMessage.mdx
diff --git a/docs/restapi/apis/userManagement/addNotificationAccount.mdx b/docs/restapi/apis/userManagement/addNotificationAccount.mdx
diff --git a/docs/restapi/apis/userManagement/getSpecifiedUser.mdx b/docs/restapi/apis/userManagement/getSpecifiedUser.mdx
diff --git a/docs/restapi/apis/userManagement/getSubscribeUsersStatus.mdx b/docs/restapi/apis/userManagement/getSubscribeUsersStatus.mdx
diff --git a/docs/restapi/apis/userManagement/getUserIDList.mdx b/docs/restapi/apis/userManagement/getUserIDList.mdx
diff --git a/docs/restapi/apis/userManagement/getUserList.mdx b/docs/restapi/apis/userManagement/getUserList.mdx
diff --git a/docs/restapi/apis/userManagement/getUserOnlineStatusDetail.mdx b/docs/restapi/apis/userManagement/getUserOnlineStatusDetail.mdx
diff --git a/docs/restapi/apis/userManagement/searchNotificationAccount.mdx b/docs/restapi/apis/userManagement/searchNotificationAccount.mdx
diff --git a/docs/restapi/apis/userManagement/subscribeUsersStatus.mdx b/docs/restapi/apis/userManagement/subscribeUsersStatus.mdx
diff --git a/docs/restapi/apis/userManagement/updateGlobalRemind.mdx b/docs/restapi/apis/userManagement/updateGlobalRemind.mdx
diff --git a/docs/restapi/apis/userManagement/updateUserInfo.mdx b/docs/restapi/apis/userManagement/updateUserInfo.mdx
