频道API

获取频道列表

GetChannelList

接口

地址版本方式权限
/api/v1/channel/listv1POST通用权限-查看频道

描述

用于获取指定群下所有频道的集合

入参

字段类型必传说明
islandIdstring群号

出参

字段类型说明
statusint返回码
messagestring返回信息
datalist<object>数据列表

数据

字段类型说明
channelIdstring频道ID
channelNamestring频道名称
channelTypeint频道类型,1:文字频道,2:语音频道,4:帖子频道,5:链接频道,6:资料频道
defaultFlagint默认访问频道标识,0:否,1:是
groupIdstring分组ID
groupNamestring分组名称

入参示例

{
    "islandId": "10001"
}

出参示例

{
   "status": 0,
   "message": "success",
   "data": [{
           "channelId": "1234501",
           "channelName": "测试频道1",
           "channelType": 1,
           "defaultFlag": 1,
           "groupId": "123450101",
           "groupName": "测试分组"
       }, {
           "channelId": "1234502",
           "channelName": "测试频道2",
           "channelType": 1,
           "defaultFlag": 0,
           "groupId": "",
           "groupName": ""
       }
   ]
}

获取频道信息

GetChannelInfo

接口

地址版本方式权限
/api/v1/channel/infov1POST通用权限-查看频道

描述

用于获取指定频道的详细信息

入参

字段类型必传说明
channelIdstring频道ID

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
channelIdstring频道ID
channelNamestring频道名称
channelTypeint频道类型,1:文字频道,2:语音频道,4:帖子频道,5:链接频道,6:资料频道
islandIdstring群号
defaultFlagint默认访问频道标识,0:否,1:是
groupIdstring分组ID
groupNamestring分组名称

入参示例

{
    "channelId": "1000101"
}

出参示例

{
   "status": 0,
   "message": "success",
   "data": {
       "channelId": "1234501",
       "channelName": "测试频道1",
       "channelType": 1,
       "islandId": "10001",
       "defaultFlag": 1,
       "groupId": "123450101",
       "groupName": "测试分组"
   }
}

创建频道

SetChannelAdd

接口

地址版本方式权限
/api/v1/channel/addv1POST通用权限-管理频道与分组

描述

用于在指定群下创建指定频道

提示

按DoDo群限制,10次/30秒

入参

字段类型必传说明
islandIdstring群号
channelNamestring频道名称,非必传,不传时设置新的频道,不能大于32个字符或16个汉字
channelTypeint频道类型,1:文字频道,2:语音频道(默认自由模式),4:帖子频道(默认详细模式)

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
channelIdstring频道ID

入参示例

{
    "islandId": "10001",
    "channelName": "测试频道1",
    "channelType": 1
}

出参示例

{
   "status": 0,
   "message": "success",
   "data": {
       "channelId": "1234502"
   }
}

编辑频道

SetChannelEdit

接口

地址版本方式权限
/api/v1/channel/editv1POST通用权限-管理频道与分组 或 通用权限-编辑频道、通用权限-查看频道

描述

用于在指定群下编辑指定频道信息

入参

字段类型必传说明
islandIdstring群号
channelIdstring频道ID
channelNamestring频道名称,非必传,不传时默认不改动,不能大于32个字符或16个汉字

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "channelId": "1234501",
    "channelName": "测试频道1"
}

出参示例

{
   "status": 0,
   "message": "success"
}

删除频道

SetChannelRemove

接口

地址版本方式权限
/api/v1/channel/removev1POST通用权限-管理频道与分组、通用权限-查看频道

描述

用于在指定群下删除指定频道

提示

按DoDo群限制,1次/10秒

入参

字段类型必传说明
islandIdstring群号
channelIdstring频道ID

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "channelId": "1234501"
}

出参示例

{
   "status": 0,
   "message": "success"
}