跳转至

群管理

主动调用通用参数请参阅全局说明

SDK示例:https://github.com/youduim/youdu-sdk-java

创建群

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/group/create?accessToken=$access_token

请求结构体

{
     "name": "$group_name",
}

参数说明

参数 必须 说明
name 群名称。不能超过32个字符(包括汉字和英文字母)

返回结果

{
     "id":  $group_id
}

id为唯一的群标示,字符串类型

删除群

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/group/delete?&accessToken=$access_token&id=$groupId

参数说明

参数 必须 说明
id 群Id

返回结果

全局状态码

修改群名称

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/group/update?accessToken=$access_token

请求结构体

{
     "id": "$group_id",
     "name": "$group_name",
}

参数说明

参数 必须 说明
id 群Id
name 群名称。不能超过32个字符(包括汉字和英文字母)

返回结果

全局状态码

查看群信息

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/group/info?accessToken=$access_token&id=$groupId

参数说明

参数 必须 说明
id 群Id

返回结果 (encrypt) {

      "id":$groupId,
      "name":$name,
      "members":[
           {"account":$userId1, "name": $name1, "mobile": $mobile1},
           {"account":$userId2, "name": $name2, "mobile": $mobile2}
      ]
}

群列表

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/group/list?accessToken=$access_token&userId=$userId

参数说明

参数 必须 说明
userId 用户id,不带参数时查询所有的群

返回结果(encrypt)

{
 "groupList":[
     {"id":$id,"name":$name},
     {"id":$id,"name":$name}
 ]
}

添加群成员

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/group/addmember?accessToken=$access_token

请求结构体

{
     "id": "$group_id",
     "userList":[ "$userId1", "$userId2"]
}

参数说明

参数 必须 说明
id 群Id
userList 成员列表

返回结果

全局状态码

删除群成员

请求说明

POST方式请求URL: http://[SERVER:7080]/cgi/group/delmember?accessToken=$access_token

请求结构体

{
     "id": "$group_id",
     "userList":[ "$userId1", "$userId2"]
}

参数说明

参数 必须 说明
id 群Id
userList 成员列表

返回结果

全局状态码

查询用户是否为群成员

请求说明

GET方式请求URL: http://[SERVER:7080]/cgi/group/ismember?accessToken=$access_token&id=$groupId&userId=$userId

参数说明

参数 必须 说明
id 群Id
userId 用户Id

返回结果

{
      "belong": true // true表示属于,false表示不属于
}