嘟哩开放平台
快速开始 开放接口 嘟哩官网
简
简体中文
繁體中文
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表示不属于

失败：发生错误（如请求失败），抛出异常，见错误码。