群组相关

获取群组信息、创建群组、查询加入的群和讨论

获取群组信息

通过讨论/群聊/广播id,获取在可查询范围内的会话(讨论/群聊/广播)相关信息

请求示例
GET https://api.lunkr.cn/api/groups/info?accessToken=ACCESS_TOKEN&groupId=1234

Content-Type: application/json;charset=utf-8
请求参数
属性 类型 非空 描述
accessToken string * 调用接口凭证
groupId string * 群组id
返回参数
属性 类型 说明
code string 返回码
var object 返回数据
groupId string 群组id
groupName string 群组名称
groupType string 群组类型(讨论:topic,公有群:public,广播:sysTopic)
createTime long 创建时间
memberCount int 群成员数量
subscribers array 订阅者列表(广播时返回)
members array 群成员列表
-- userId string 用户UserID,对应论客的帐号
-- email string 邮箱,对应论客的邮箱账号
-- userName string 用户名称
返回示例
{
    "code": "10000",
    "var": {
        "groupId": "1234",
        "groupName": "测试讨论",
        "groupType": "topic",
        "createTime": 1538969841000,
        "memberCount": 3,
        "subscribers":[],
        "members":[{
            "userId": "16",
            "email": "test10@test.com",
            "userName": ""
        }, {
            "userId": "7",
            "email": "test@test.com",
            "userName": "真的姓名"
        }, {
            "userId": "12",
            "email": "test6@test.com",
            "userName": "test6@test.com"
        }]
    }
}
返回码
返回码 说明
10000 正常返回
10001 未知错误
10006 无权限操作
20201 群组未找到

创建群组

用于创建群组.

请求示例
POST https://api.lunkr.cn/api/groups/create?accessToken=ACCESS_TOKEN

Content-Type: application/json;charset=utf-8

{
  "name": "apiGroup",
  "groupType": "topic",
  "members": "test@test.com,test2@test.com"
}
请求参数
属性 类型 非空 描述
name string * 群组名称
groupType string * 群组类型(讨论:topic,公有群:public,广播:sysTopic)
members string * 群成员(类型为广播时表示管理员)
subscribers string 订阅者(类型为广播时传入)
返回参数
属性 类型 说明
code string 返回码
var object 返回数据
-- groupId string 群组id
返回示例
{
    "code": "10000",
    "var": {
        "groupId": "10664"
    }
}
返回码
返回码 说明
10000 正常返回
20102 群类型参数错误

查询加入的群和讨论

返回userId用户加入的所有群和讨论信息.

请求示例
GET https://api.lunkr.cn/api/groups/list?accessToken=ACCESS_TOKEN&userId=test@test.com

Content-Type: application/json;charset=utf-8
请求参数
属性 类型 非空 描述
accessToken string * 调用接口凭证
userId string * 用户UserID,对应论客的帐号,email或uid
返回参数
属性 类型 说明
code string 返回码
var object 返回数据
sysTopic array 广播
-- userId string 广播UserID,对应论客的uid
-- email string 广播email,对应论客的email账号
-- userName string 广播名称
-- role int 角色:0管理员 1订阅者
topic array 讨论
-- userId string 讨论UserID,对应论客的uid
-- email string 讨论email,对应论客的email账号
-- userName string 讨论名称
group array 公有群
-- userId string 群UserID,对应论客的uid
-- email string 群email,对应论客的email账号
-- userName string 群名称
返回示例
{
    "code": "10000",
    "data": {
        "topic": [{
            "userId": "10503",
            "email": "t..166c8f90691@robot.lunkr.cn",
            "userName": "topic test"
        }, {
            "userId": "10504",
            "email": "t..166c8f95e37@robot.lunkr.cn",
            "userName": "topic test"
        }, {
            "userId": "10617",
            "email": "t..166f2574394@robot.lunkr.cn",
            "userName": "第三方建普通"
        }],
        "group": [{
            "userId": "1063",
            "email": "c..166f649c1f8@robot.lunkr.cn",
            "userName": "apiGroup111"
        }, {
            "userId": "10490",
            "email": "c..166c48e90dc@robot.lunkr.cn",
            "userName": "群 test"
        }, {
            "userId": "10493",
            "email": "c..166c4916d17@robot.lunkr.cn",
            "userName": "群 test"
        }]
    }
}
返回码
返回码 说明
10000 正常返回
10001 其他错误
10006 无权限操作
20101 查找不到用户

results matching ""

    No results matching ""