4 群介面#
4.1 添加群管理員#
POST /group/admin/add
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.2 管理員token直接拉群成員#
POST /group/admin/member_join
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.3 移除群管理員#
DELETE /group/admin/remove
POST /group/admin/remove
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.4 取得群管理員列表#
GET /group/admin_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ expired_time | int64 | 禁言過期時間(毫秒) |
| ⇥ join_time | int64 | 成員入群時間戳(毫秒) |
| ⇥ user_id | int64 | 使用者id |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.5 根據群id和公告id取得群公告詳情#
GET /group/announcement
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| announcement_id | int64 | true | 公告ID |
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ author | int64 | 公告發布者 |
| ⇥ content | string | 公告內容 |
| ⇥ created_at | int64 | 公告發布時間(毫秒) |
| ⇥ group_id | int64 | 群id |
| ⇥ id | int64 | 公告id |
| ⇥ title | string | 公告標題 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.6 刪除公告#
DELETE /group/announcement/delete
POST /group/announcement/delete
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| announcement_id | int64 | true | 公告ID |
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.7 編輯群公告#
POST /group/announcement/edit
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| content | string | true | 公告內容 | |
| group_id | int64 | true | 群組id | |
| title | string | true | 公告標題 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ author | int64 | 公告發布者 |
| ⇥ content | string | 公告內容 |
| ⇥ created_at | int64 | 公告發布時間(毫秒) |
| ⇥ group_id | int64 | 群id |
| ⇥ id | int64 | 公告id |
| ⇥ title | string | 公告標題 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.8 取得最新一條群公告詳情#
GET /group/announcement/last
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ author | int64 | 公告發布者 |
| ⇥ content | string | 公告內容 |
| ⇥ created_at | int64 | 公告發布時間(毫秒) |
| ⇥ group_id | int64 | 群id |
| ⇥ id | int64 | 公告id |
| ⇥ title | string | 公告標題 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.9 取得群公告列表#
GET /group/announcement/list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ author | int64 | 公告發布者 |
| ⇥ content | string | 公告內容 |
| ⇥ created_at | int64 | 公告發布時間(毫秒) |
| ⇥ group_id | int64 | 群id |
| ⇥ id | int64 | 公告id |
| ⇥ title | string | 公告標題 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.10 取得群申請列表#
POST /group/application_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標: 從哪開始取 |
| limit | int32 | false | 最多取多少條 |
| version | int64 | false | 版本號 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_list | array[int64] | true | 群id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，用於翻頁 |
| data | array[object] | 結果資料 |
| ⇥ applicant_id | int64 | 申請者的使用者ID |
| ⇥ expired_time | int64 | 申請過期時間戳（毫秒） |
| ⇥ group_id | int64 | 群組ID |
| ⇥ reason | string | 原因 |
| ⇥ status | int32 | 狀態： 0 - 待處理，1 - 同意，2 - 拒絕 |
| message | string | 錯誤信息，如果成功，該項為null |
| total | int64 | 總數 |
| version | int64 | 版本，目前沒用到，留作擴展 |
介面描述#
4.11 申請入群#
POST /group/apply
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| reason | string | false | 申請入群原因 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.12 管理員處理入群申請#
PUT /group/apply/handle
POST /group/apply/handle
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| approval | boolean | true | 審批，bool類型，true為同意，false為拒絕 | |
| group_id | int64 | true | 群id | |
| user_id | int64 | true | 使用者id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.13 將使用者禁言#
POST /group/ban
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| duration | int64 | true | 禁言時長，單位為分鐘 | |
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.14 取得禁言列表#
GET /group/banned_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標：從哪開始取 |
| group_id | int64 | true | 群組ID |
| limit | int32 | false | 取多少條 |
| version | int64 | false | 版本 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，用於翻頁 |
| data | array[object] | 結果資料 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ expired_time | int64 | 禁言過期時間(毫秒) |
| ⇥ join_time | int64 | 成員入群時間戳(毫秒) |
| ⇥ user_id | int64 | 使用者id |
| message | string | 錯誤信息，如果成功，該項為null |
| total | int64 | 總數 |
| version | int64 | 版本，目前沒用到，留作擴展 |
介面描述#
4.15 將使用者加入黑名單#
POST /group/block
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.16 取得黑名單列表#
GET /group/blocked_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標：從哪開始取 |
| group_id | int64 | true | 群組ID |
| limit | int32 | false | 取多少條 |
| version | int64 | false | 版本 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，用於翻頁 |
| data | array[object] | 結果資料 |
| ⇥ created_at | string | 建立時間 |
| ⇥ group_id | int64 | 群組ID |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
| total | int64 | 總數 |
| version | int64 | 版本，目前沒用到，留作擴展 |
介面描述#
4.17 建立群#
POST /group/create
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| avatar | string | false | 群頭像 | |
| description | string | false | 群描述 | |
| name | string | false | 群名稱 | |
| type | int32 | false | 群類型 0表示私有群, 1表示公開群, 2表示聊天室, 3表示臨時群 | |
| user_list | array[int64] | false | 邀請入群的使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ apply_approval | int32 | 入群申請審批設定, 0:同意所有申請 1:需要管理員確認 2:拒絕所有申請 |
| ⇥ avatar | string | 群頭像 |
| ⇥ ban_expire_time | int64 | 全員禁言過期時間（秒），禁言期間只允許管理員發訊息， 為0或小於當前時間表示不禁言, -1表示永久禁言 |
| ⇥ capacity | int64 | 群容量 |
| ⇥ count | int64 | 當前人數 |
| ⇥ created_at | int64 | 建立時間(毫秒） |
| ⇥ description | string | 群描述 |
| ⇥ ext | string | 群擴展信息 |
| ⇥ group_id | int64 | 群id |
| ⇥ hide_member_info | boolean | 是否隱藏群成員詳細信息： true - 隱藏， false - 不隱藏 |
| ⇥ history_visible | boolean | 新成員可見歷史聊天記錄設定： true - 新成員可見歷史聊天記錄， false - 新成員不可見歷史聊天記錄 |
| ⇥ member_invite | boolean | 是否允許群成員邀請其他人入群: true - 群成員允許邀請其他人入群， false - 群成員不允許邀請其他人入群 |
| ⇥ member_modify | boolean | 群成員修改群信息設定： true - 允許群成員修改群信息， false - 不允許群成員修改群信息 |
| ⇥ msg_mute_mode | int32 | 群訊息屏蔽模式：0 - 表示不屏蔽， 1 - 表示屏蔽本地訊息通知， 2 - 表示屏蔽訊息，不接收訊息 |
| ⇥ msg_push_mode | int32 | 群訊息推播模式：0 - 接收所有推播， 1 - 不接受推播， 2 - 接收管理員和@訊息推播， 3 - 只接收管理員訊息推播，4 - 只接收@訊息推播 |
| ⇥ name | string | 群名稱 |
| ⇥ owner_id | int64 | 群主id |
| ⇥ read_ack | boolean | 是否開啟群訊息已讀功能設定：true - 開啟群訊息已讀功能， false - 不開啟群訊息已讀功能 |
| ⇥ status | int32 | 群狀態, 0：正常, 1：已解散 |
| ⇥ type | int32 | 群類型：0 - 表示私有群, 1 - 表示公開群, 2 - 表示聊天室, 3 - 表示臨時群 |
| ⇥ updated_at | int64 | 更新時間（毫秒） |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.18 解散群#
DELETE /group/destroy
POST /group/destroy
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.19 更新群名片#
PUT /group/display_name
POST /group/display_name
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | string | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.20 下載群檔案#
GET /group/file
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| file_id | int64 | true | 檔案ID |
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ created_at | int64 | 建立時間戳(毫秒) |
| ⇥ file_id | int64 | 共享檔案id |
| ⇥ group_id | int64 | 群id |
| ⇥ name | string | 共享檔案名稱 |
| ⇥ size | int64 | 共享檔案大小 |
| ⇥ type | string | 共享檔案類型 |
| ⇥ updated_at | int64 | 更新時間戳(毫秒) |
| ⇥ uploader | int64 | 共享檔案上傳者 |
| ⇥ url | string | 共享檔案url |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.21 刪除群檔案#
DELETE /group/file/delete
POST /group/file/delete
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| file_list | array[int64] | true | 檔案id列表 | |
| group_id | int64 | true | 群id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ file_id | int64 | 檔案ID |
| ⇥ reason | string | 原因 |
| ⇥ result | string | 結果： success - 成功, fail - 失敗 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.22 取得群檔案列表#
GET /group/file/list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ created_at | int64 | 建立時間戳(毫秒) |
| ⇥ file_id | int64 | 共享檔案id |
| ⇥ group_id | int64 | 群id |
| ⇥ name | string | 共享檔案名稱 |
| ⇥ size | int64 | 共享檔案大小 |
| ⇥ type | string | 共享檔案類型 |
| ⇥ updated_at | int64 | 更新時間戳(毫秒) |
| ⇥ uploader | int64 | 共享檔案上傳者 |
| ⇥ url | string | 共享檔案url |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.23 更新群檔案名稱#
PUT /group/file/update_name
POST /group/file/update_name
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| file_id | int64 | true | 檔案id | |
| group_id | int64 | true | 群id | |
| name | string | true | 檔案新名稱 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.24 上傳群檔案#
POST /group/file/upload
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| name | string | true | 檔案名稱 | |
| size | int64 | true | 檔案大小 | |
| type | string | false | 檔案類型 | |
| url | string | true | 檔案url |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ created_at | int64 | 建立時間戳(毫秒) |
| ⇥ file_id | int64 | 共享檔案id |
| ⇥ group_id | int64 | 群id |
| ⇥ name | string | 共享檔案名稱 |
| ⇥ size | int64 | 共享檔案大小 |
| ⇥ type | string | 共享檔案類型 |
| ⇥ updated_at | int64 | 更新時間戳(毫秒) |
| ⇥ uploader | int64 | 共享檔案上傳者 |
| ⇥ url | string | 共享檔案url |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.25 根據group id取得群信息#
GET /group/info
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ apply_approval | int32 | 入群申請審批設定, 0:同意所有申請 1:需要管理員確認 2:拒絕所有申請 |
| ⇥ avatar | string | 群頭像 |
| ⇥ ban_expire_time | int64 | 全員禁言過期時間（秒），禁言期間只允許管理員發訊息， 為0或小於當前時間表示不禁言, -1表示永久禁言 |
| ⇥ capacity | int64 | 群容量 |
| ⇥ count | int64 | 當前人數 |
| ⇥ created_at | int64 | 建立時間(毫秒） |
| ⇥ description | string | 群描述 |
| ⇥ ext | string | 群擴展信息 |
| ⇥ group_id | int64 | 群id |
| ⇥ hide_member_info | boolean | 是否隱藏群成員詳細信息： true - 隱藏， false - 不隱藏 |
| ⇥ history_visible | boolean | 新成員可見歷史聊天記錄設定： true - 新成員可見歷史聊天記錄， false - 新成員不可見歷史聊天記錄 |
| ⇥ member_invite | boolean | 是否允許群成員邀請其他人入群: true - 群成員允許邀請其他人入群， false - 群成員不允許邀請其他人入群 |
| ⇥ member_modify | boolean | 群成員修改群信息設定： true - 允許群成員修改群信息， false - 不允許群成員修改群信息 |
| ⇥ msg_mute_mode | int32 | 群訊息屏蔽模式：0 - 表示不屏蔽， 1 - 表示屏蔽本地訊息通知， 2 - 表示屏蔽訊息，不接收訊息 |
| ⇥ msg_push_mode | int32 | 群訊息推播模式：0 - 接收所有推播， 1 - 不接受推播， 2 - 接收管理員和@訊息推播， 3 - 只接收管理員訊息推播，4 - 只接收@訊息推播 |
| ⇥ name | string | 群名稱 |
| ⇥ owner_id | int64 | 群主id |
| ⇥ read_ack | boolean | 是否開啟群訊息已讀功能設定：true - 開啟群訊息已讀功能， false - 不開啟群訊息已讀功能 |
| ⇥ status | int32 | 群狀態, 0：正常, 1：已解散 |
| ⇥ type | int32 | 群類型：0 - 表示私有群, 1 - 表示公開群, 2 - 表示聊天室, 3 - 表示臨時群 |
| ⇥ updated_at | int64 | 更新時間（毫秒） |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.26 更新群頭像#
PUT /group/info/avatar
POST /group/info/avatar
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | string | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.27 根據group id取得群信息#
POST /group/info/batch
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_list | array[int64] | true | 群id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ apply_approval | int32 | 入群申請審批設定, 0:同意所有申請 1:需要管理員確認 2:拒絕所有申請 |
| ⇥ avatar | string | 群頭像 |
| ⇥ capacity | int64 | 群容量 |
| ⇥ count | int64 | 當前人數 |
| ⇥ group_id | int64 | 群組ID |
| ⇥ msg_mute_mode | int32 | 群訊息屏蔽模式：0 - 表示不屏蔽， 1 - 表示屏蔽本地訊息通知， 2 - 表示屏蔽訊息，不接收訊息 |
| ⇥ msg_push_mode | int32 | 群訊息推播模式：0 - 接收所有推播， 1 - 不接受推播， 2 - 接收管理員和@訊息推播， 3 - 只接收管理員訊息推播，4 - 只接收@訊息推播 |
| ⇥ name | string | 群名稱 |
| ⇥ owner | int64 | 群主id |
| ⇥ status | int32 | 群狀態, 0：正常, 1：已解散 |
| ⇥ type | int32 | 群類型：0 - 表示私有群, 1 - 表示公開群, 2 - 表示聊天室, 3 - 表示臨時群 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.28 更新群描述#
PUT /group/info/description
POST /group/info/description
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | string | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.29 更新擴展信息#
PUT /group/info/ext
POST /group/info/ext
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | string | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.30 更新群名稱#
PUT /group/info/name
POST /group/info/name
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | string | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.31 取得群邀請列表#
GET /group/invitation_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標: 從哪開始取 |
| limit | int32 | false | 最多取多少條 |
| version | int64 | false | 版本號 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，用於翻頁 |
| data | array[object] | 結果資料 |
| ⇥ expired_time | int64 | 過期時間戳（毫秒） |
| ⇥ group_id | int64 | 群組ID |
| ⇥ invitee_id | int64 | 被邀請者ID |
| ⇥ inviter_id | int64 | 邀請者ID |
| ⇥ reason | string | 原因 |
| ⇥ status | int32 | 狀態： 0 - 待處理，1 - 使用者同意，2 - 使用者拒絕 |
| ⇥ updated_at | string | 更新時間 |
| message | string | 錯誤信息，如果成功，該項為null |
| total | int64 | 總數 |
| version | int64 | 版本，目前沒用到，留作擴展 |
介面描述#
4.32 邀請入群#
POST /group/invite
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| reason | string | false | 邀請理由 | |
| user_list | array[int64] | true | 受邀請者id，List類型，單次可邀請多個使用者入群 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.33 使用者處理入群邀請#
PUT /group/invite/handle
POST /group/invite/handle
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| approval | boolean | true | 審批，bool類型，true為同意，false為拒絕 | |
| group_id | int64 | true | 群id | |
| user_id | int64 | true | 使用者id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.34 將成員踢出群#
DELETE /group/kick
POST /group/kick
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.35 成員退出群#
DELETE /group/leave
POST /group/leave
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.36 根據group id取得群成員列表#
GET /group/member_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標：從哪開始取 |
| group_id | int64 | true | 群組ID |
| limit | int32 | false | 取多少條 |
| version | int64 | false | 版本 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，用於翻頁 |
| data | array[object] | 結果資料 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ expired_time | int64 | 禁言過期時間(毫秒) |
| ⇥ join_time | int64 | 成員入群時間戳(毫秒) |
| ⇥ user_id | int64 | 使用者id |
| message | string | 錯誤信息，如果成功，該項為null |
| total | int64 | 總數 |
| version | int64 | 版本，目前沒用到，留作擴展 |
介面描述#
4.37 批量取得群成員的群名片#
POST /group/members/display_name
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ expired_time | int64 | 禁言過期時間(毫秒) |
| ⇥ join_time | int64 | 成員入群時間戳(毫秒) |
| ⇥ user_id | int64 | 使用者id |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.38 批量取得指定群成員信息#
POST /group/members/info
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群ID | |
| user_list | array[int64] | true | 使用者ID列表，最多100個 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ avatar | string | 使用者頭像 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ join_time | int64 | 成員入群時間戳（毫秒） |
| ⇥ nick_name | string | 使用者暱稱 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.39 搜索群成員#
GET /group/members/search
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| cursor | string | false | 游標 |
| group_id | int64 | true | 群組ID |
| keyword | string | true | 搜索關鍵字 |
| limit | int32 | false | 最多取多少條，預設20，有效範圍1到100，超過100按100處理 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| cursor | string | 游標，回傳結果中缺失 cursor，表示已經回傳最後一頁 |
| data | array[object] | 結果資料 |
| ⇥ avatar | string | 使用者頭像 |
| ⇥ display_name | string | 成員群名片 |
| ⇥ join_time | int64 | 成員入群時間戳（毫秒） |
| ⇥ nick_name | string | 使用者暱稱 |
| ⇥ user_id | int64 | 使用者ID |
| ⇥ username | string | 使用者名 |
| message | string | 錯誤信息，如果成功，該項為null |
| version | int64 | 版本 |
介面描述#
4.40 設定群訊息屏蔽模式#
PUT /group/msg/mute_mode
POST /group/msg/mute_mode
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| msg_mute_mode | int32 | true | 群訊息屏蔽模式： 0 - 不屏蔽1 - 屏蔽本地訊息通知2 - 屏蔽訊息，不接收訊息 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.41 設定群訊息推播模式#
PUT /group/msg/push_mode
POST /group/msg/push_mode
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| msg_push_mode | int32 | true | 群訊息推播類型： 0:接收所有推播;1:不接受推播;2:接收管理員和@訊息推播;3:只接收管理員訊息推播;4:只接收@訊息推播 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.42 取得公開群列表(已廢棄)#
GET /group/public_list
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[int64] | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.43 二維碼邀請入群#
POST /group/qrcode/invite
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| qr_info | string | true | 二維碼信息：可以通過GET /group/qrcode/sign取得 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.44 取得群邀請二維碼信息#
GET /group/qrcode/sign
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ create_at | int64 | 二維碼生成時間（毫秒） |
| ⇥ expire_at | int64 | 二維碼過期時間（毫秒） |
| ⇥ qr_info | string | 二維碼信息 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.45 取得群設定#
GET /group/settings
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求參數(Query Param)#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| group_id | int64 | true | 群組ID |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ apply_approval | int32 | 入群申請審批設定, 0:同意所有申請 1:需要管理員確認 2:拒絕所有申請 |
| ⇥ avatar | string | 群頭像 |
| ⇥ ban_expire_time | int64 | 全員禁言過期時間（秒），禁言期間只允許管理員發訊息， 為0或小於當前時間表示不禁言, -1表示永久禁言 |
| ⇥ capacity | int64 | 群容量 |
| ⇥ count | int64 | 當前人數 |
| ⇥ created_at | int64 | 建立時間(毫秒） |
| ⇥ description | string | 群描述 |
| ⇥ ext | string | 群擴展信息 |
| ⇥ group_id | int64 | 群id |
| ⇥ hide_member_info | boolean | 是否隱藏群成員詳細信息： true - 隱藏， false - 不隱藏 |
| ⇥ history_visible | boolean | 新成員可見歷史聊天記錄設定： true - 新成員可見歷史聊天記錄， false - 新成員不可見歷史聊天記錄 |
| ⇥ member_invite | boolean | 是否允許群成員邀請其他人入群: true - 群成員允許邀請其他人入群， false - 群成員不允許邀請其他人入群 |
| ⇥ member_modify | boolean | 群成員修改群信息設定： true - 允許群成員修改群信息， false - 不允許群成員修改群信息 |
| ⇥ msg_mute_mode | int32 | 群訊息屏蔽模式：0 - 表示不屏蔽， 1 - 表示屏蔽本地訊息通知， 2 - 表示屏蔽訊息，不接收訊息 |
| ⇥ msg_push_mode | int32 | 群訊息推播模式：0 - 接收所有推播， 1 - 不接受推播， 2 - 接收管理員和@訊息推播， 3 - 只接收管理員訊息推播，4 - 只接收@訊息推播 |
| ⇥ name | string | 群名稱 |
| ⇥ owner_id | int64 | 群主id |
| ⇥ read_ack | boolean | 是否開啟群訊息已讀功能設定：true - 開啟群訊息已讀功能， false - 不開啟群訊息已讀功能 |
| ⇥ status | int32 | 群狀態, 0：正常, 1：已解散 |
| ⇥ type | int32 | 群類型：0 - 表示私有群, 1 - 表示公開群, 2 - 表示聊天室, 3 - 表示臨時群 |
| ⇥ updated_at | int64 | 更新時間（毫秒） |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.46 更新群設定--是否允許成員邀請#
PUT /group/settings/allow_member_invitation
POST /group/settings/allow_member_invitation
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | boolean | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.47 更新群設定--群成員是否可修改群信息#
PUT /group/settings/allow_member_modify
POST /group/settings/allow_member_modify
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | boolean | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.48 全員禁言，只允許管理員發訊息#
POST /group/settings/ban_all
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| duration | int64 | true | 禁言時長，單位為分鐘 | |
| group_id | int64 | true | 群id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ ban_expire_time | int64 | 全員禁言過期時間（秒），禁言期間只允許管理員發訊息， 為0或小於當前時間表示不禁言, -1表示永久禁言 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.49 更新群設定--是否開啟群訊息已讀功能#
PUT /group/settings/enable_read_ack
POST /group/settings/enable_read_ack
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | boolean | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.50 更新群設定--是否隱藏群成員詳細信息#
PUT /group/settings/hide_member_info
POST /group/settings/hide_member_info
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | boolean | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.51 更新群設定--新成員是否可見群歷史聊天記錄#
PUT /group/settings/history_visible
POST /group/settings/history_visible
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| value | boolean | true | 更新內容 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.52 更新群設定--群申請是否需要管理員審批#
PUT /group/settings/require_admin_approval
POST /group/settings/require_admin_approval
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| apply_approval | int32 | true | 入群申請審批設定, 0:同意所有申請 1:需要管理員確認 2:拒絕所有申請 | |
| group_id | int64 | true | 群id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.53 取消全員禁言#
POST /group/settings/unban_all
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | boolean | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.54 轉讓群#
PUT /group/transfer
POST /group/transfer
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| new_owner | int64 | true | 新群主的user_id |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | object | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.55 從禁言列表移除使用者#
POST /group/unban
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.56 從黑名單移除使用者#
DELETE /group/unblock
POST /group/unblock
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
請求體(Request Body)#
| 參數名稱 | 資料類型 | 必填 | 預設值 | 描述 |
|---|---|---|---|---|
| group_id | int64 | true | 群id | |
| user_list | array[int64] | true | 使用者id列表 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[object] | 結果資料 |
| ⇥ reason | string | 錯誤信息 |
| ⇥ result | string | 操作結果： success - 成功, fail - 失敗 |
| ⇥ user_id | int64 | 使用者ID |
| message | string | 錯誤信息，如果成功，該項為null |
介面描述#
4.57 取得使用者的群組列表#
GET /group/user_joined
請求頭#
| 參數名稱 | 資料類型 | 必填 | 描述 |
|---|---|---|---|
| access-token | string | false | Token |
| app_id | string | true | 應用程式ID |
| group_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此群ID的管理員身份來呼叫此介面 |
| user_id | int64 | false | 僅當access-token為管理員token時，可以設定此欄位，表示以此使用者ID的身份來呼叫此介面 |
響應體#
● 200 響應資料格式：JSON
| 參數名稱 | 類型 | 描述 |
|---|---|---|
| code | int32 | 回傳碼，200是成功 |
| data | array[int64] | 結果資料 |
| message | string | 錯誤信息，如果成功，該項為null |