嘟哩開放平臺
简体中文
繁體中文
English
快速開始 開放接口 嘟哩官網
模板

群組管理


企業可以使用群組相關介面能力,實現動態建群、添加群成員、群組管理。


創建群


功能說明

創建群組

參數說明

參數

類型

是否必填

說明

org_id

string

Y

組織id

creator_account_id

string

Y

創建者id


group_name

string

Y

群組名稱(不超過32個中、英文字元)

account_list

string[]

Y

群成員數組

“100000-5000132282”代表:

100000:[組織id]

5000132282:[用戶id]

返回結果說明

返回結果說明

成功:返回群組資訊、群組成員資訊

失敗:發生錯誤(如請求失敗),拋出异常,見錯誤碼。


獲取群資訊


功能說明

根據群組id獲取群組詳細資訊


請求參數

参数

類型

是否必填

說明

access_token

string

Y

認證的token

group_id

string

Y

群Id


返回結果說明

成功:返回群組資訊、群組成員資訊

失敗:發生錯誤(如請求失敗),拋出异常,見錯誤碼。


修改群名稱


功能說明

通過群id修改群組名稱。


參數說明

參數

類型

是否必填

說明

group_id

string

Y

群Id

group_name

string

Y

群名稱。 不能超過32個字元(包括漢字和英文字母)


返回結果說明

成功:返回群組id和群名稱

失敗:發生錯誤(如請求失敗),拋出异常,見錯誤碼。


添加群成員


功能說明

為已有的群組添加成員。


參數說明

參數

類型

是否必填

說明

group_id

string

群Id

creator_account_id

string

創建者id

org_id

string

組織id

account_list

array

成員列表

[{

"org_id": "100000",

"account_id": "5000132294",


}]


返回結果說明

成功:返回群組id和群名稱

失敗:發生錯誤(如請求失敗),拋出异常,見錯誤碼。


是否為群成員


功能說明

通過群組id和成員id,判斷是否為群成員

請求參數

參數

必须

說明

group_id

群Id

org_id

組織id

account_id

用戶Id


返回結果說明

成功:返回群組id和是否群成員標識:“is_group_member”:true // true表示屬於,false表示不屬於

失敗:發生錯誤(如請求失敗),拋出异常,見錯誤碼。