Demo entry 6784858

频道对外接口(国内新ServiceAgent版)

   

Submitted by anonymous on Mar 11, 2019 at 03:29
Language: Thrift. Code size: 21.8 kB.

namespace cpp ych.channel_interface
namespace java ych.channel_interface
namespace go ych.channel_interface
/*通用机构体 开始*/
struct AuthorizeMsg
{
	1:string AppKey="", //接入鉴权用户名,自助接入平台系统分配
	2:string AppSecret="", //接入鉴权密码,自助接入平台系统分配
	3:map<string,string> keyvalue, //扩展
}
struct CommonRes
{
	1:i32 rescode, //调用结果码,默认为0,必选
	2:map<string,string> keyvalue, //扩展,必选
	3:i32 retcode, //通用返回码
	4:string retstr, //通用返回提示信息
}
/*
struct FailSid
{
    1:i64 sid, //失败频道号
    2:i32 retcode, //通用返回码
    3:string retstr, //通用返回提示信息
}
struct FailUid
{
    1:i64 uid, //失败用户uid
    2:i32 retcode, //通用返回码
    3:string retstr, //通用返回提示信息
}
*/
/*通用机构体 结束*/
/*保活(检查连通性)开始*/
struct pingReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i32 uTime, //时间戳单位秒
}
/*保活(检查连通性)结束*/

/*麦序模块接口 开始*/
struct topFirstReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i64 uid, //被置为首麦用户uid
	5:i32 time, //时间,单位秒
}
struct kickoffQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i64 uid, //被出踢麦序用户uid
}
struct joinQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i64 uid, //加入麦序用户uid
	5:i32 time, //时间,单位秒
}
struct muteQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:bool mute, //mute:true-控麦,false-解控
}
struct disableQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:bool disable, //disable:true-禁麦,false-解禁
}
struct setTimeQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i32 time, //时间,单位秒
}
struct settopFirstQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i64 uid, //被置为首麦用户uid
	5:i32 time, //时间,单位秒
}
struct getQueueReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
}
struct getQueueRes
{
	1:i32 rescode, //调用结果码,默认为0,必选
	2:map<string,string> keyvalue, //扩展,必选
	3:i32 retcode, //通用返回码
	4:string retstr, //通用返回提示信息
	5:list<i64> queue, //麦序用户列表
}
/*麦序模块接口 结束*/
/*公屏模块接口 开始*/
struct sendTextChatReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:i64 uid,  //发送者uid
	5:string chat, //内容 特殊编码
	6:string nick, //昵称
	7:map<i16, string> extInfo, //扩展信息
	8:map<i32, string> extProps, //扩展属性
}
/*公屏模块接口 结束*/
/*在线模块接口 开始*/
struct robotLoginReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:list<i64> uids, //机器人uid列表
}
struct robotLogoutReq
{
	1:AuthorizeMsg authmsg, //鉴权信息,必选
	2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
	4:list<i64> uids, //机器人uid列表
}
struct getTopChannelUserCountReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
}
struct getTopChannelUserCountRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
	4:string retstr, //通用返回提示信息
    5:i32 totalCnt, //总人数,一般用于UI展示
    6:i32 realCnt, //真实人数
    7:i32 virtualCnt, //虚拟人数
}
struct getBatchTopChannelUserCountReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:list<i64> topsids //频道号集合
}
struct UserCount 
{
    1:i32 totalCnt, //总人数,一般用于UI展示
    2:i32 realCnt, //真实人数
    3:i32 virtualCnt, //虚拟人数
}
struct getBatchTopChannelUserCountRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:map<i64, UserCount> succUserCounts, //key i64为获取成功的顶级频道号,value struct为对应频道各类人数信息
    4:list<i64> failUserCounts, //获取失败的顶级频道号集合
}
struct getTopChannelUserListReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 count, //本次拉取uid个数的最大值
    4:i64 cursor, // 拉取游标。首次填0,后续填返回值中带的cursor值
}
struct getTopChannelUserListRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3: i32 retcode, //通用返回码
    4: string retstr, //通用返回提示信息
    5: i64 topsid, //顶级频道号
    6: i64 cursor, //本次拉取的游标
    7: list<i64> uids, //用户uid列表
}
struct getTopChannelUserListByTimeReverseReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 count, //本次拉取uid个数的最大值
    4:i64 cursor, // 拉取游标。首次填0,后续填返回值中带的cursor值
}
struct getTopChannelUserListByTimeReverseRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3: i32 retcode, //通用返回码
    4: string retstr, //通用返回提示信息
    5: i64 topsid, //顶级频道号
    6: i64 cursor, //本次拉取的游标
    7: list<i64> uids, //用户uid列表
}
struct setChannelUserCountReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:i32 count, //设置的人气值
    5:bool bfloat, //bfloat:true-显示人数=真实人数+虚拟人数,false-显示人数=虚拟人数
}
struct updateVirtualCntReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
    4:i32 count, //虚拟人数
    5:i32 op,  //op:0-增加,1-减少,3-设置
}
struct setVirtualCntModeReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 sid, //频道号
    3:i32 mode, //mode:0-显示人数=虚拟人数,1-显示人数=真实人数+虚拟人数
}
/*在线模块接口 结束*/
/*频道信息模块接口 开始*/
struct getChannelInfoReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
    4:list<i64> keys, //频道信息属性。常用的属性值请参见上文,如需详细信息请咨询王书孝。
}
struct getChannelInfoRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
    4:string retstr, //通用返回提示信息
    5:map<i64, string> props, //频道信息属性
}
struct getBatchTopChannelInfoReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:list<i64> topsids, //子频道号集合
    3:list<i64> keys, //频道信息属性。常用的属性值请参见上文,如需详细信息请咨询王书孝。
}
struct getBatchTopChannelInfoRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:map<i64, map<i64, string> > succChanInfos, //获取成功的频道号集合,key i64为频道号,value map为频道信息属性
    4:list<i64> failChanInfos, //获取失败的频道号集合
}
struct updateChannelInfoReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
	3:i64 subsid, //子频道号
    4:map<i64, string> props, //频道信息属性。常用的属性值请参见上文,如需详细信息请咨询王书孝。
}
struct getOwnedTopChannelReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    //2:i32 appType, //频道所属业务标识,向王书孝申请 authmsg.AppKey替换appType
    2:i64 uid, //创建者uid
}
struct getOwnedTopChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
    4:string retstr, //通用返回提示信息
    5:list<i64> topsids, //创建的顶级频道号列表
}
/*频道信息模块接口 结束*/
/*用户信息模块接口 开始*/
struct updateUserInfoReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 uid, 
    3:map<i32, string> props,
   
}
/*用户信息模块接口 结束*/
/*频道管理模块接口 开始*/
struct createChannelReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    //2:i32 appType, //频道所属业务标识,向王书孝申请 authmsg.AppKey替换appType
    2:i64 owner, //频道的所有者
    3:map<i32, string> props, //频道信息属性,常用的属性值见下表。
}
struct createChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码、后端服务自定义返回码
    4:string retstr, //返回提示信息
    5:i64 topsid, //创建的顶级频道号
}
struct createSubChannelInfo
{
    1:i64 creator //创建者uid
    2:string name, //子频道名称
    3:bool limit, //子频道只对会员及嘉宾开放
    4:bool pub, //是否对游客开放
    5:string hello, //频道接待语
    6:i64 pid; //父频道
    7:i64 topsid; //顶级频道
    8:string password, //频道密码
    9:i32 qc, //语音质量 0:quality(高音质), 1:realtime(高实时性)
}
struct createSubChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:createSubChannelInfo info, //创建子频道所需信息
}
struct dismissSubChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
}
struct setJiedaiReq{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道
    3:i64 subsid, //需要设置接待的子频道
    4:bool bSet, 
}
struct createTempChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 owner, //所有者uid
    3:i64 appKey, //原appid
}
struct tempSidRes
{
    1:i64 topsid, //频道号
    2:i64 ownerId, //所有者uid
}  
struct createTempChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:i64 topsid, //创建的频道号
}      
struct freezeChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i32 unfrozenTime, //解冻时间戳
}
struct unfreezeChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid,  //顶级频道号
}
struct loadFrozenChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
}
struct loadFrozenChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:map<i64, i32> res, //顶级频道号-解冻时间戳
}
struct isFrozenChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:list<i64> sids, //顶级频道号列表
}
struct isFrozenChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:map<i64, i32> res, //顶级频道号-解冻时间戳
} 
struct lockChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i32 unlockTime, //解锁时间戳
}
struct unlockChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
}
struct loadLockedChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
}  
struct loadLockedChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:map<i64, i32> res, //顶级频道号-解锁时间戳
}
struct isLockedChannelReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:list<i64> sids, //顶级频道号列表
} 
struct isLockedChannelRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:map<i64, i32> res, //顶级频道号-解锁时间戳
}
struct addMIITControlListReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:list<i64> uids, //管制用户uid列表
}
struct delMIITControlListReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:list<i64> uids, //管制用户uid列表
}
struct updateChannelConfigReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 sid, //顶级频道号
    3:map<i16, bool> options, //频道开关
    4:map<i16, i32> parametres, //频道参数
}
struct removeChannelConfigReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 sid, //顶级频道号
}
struct getChannelConfigReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 sid, //顶级频道号
}
struct ChannelSwitchRes
{
  1:map<i16, bool> options, //频道开关
  2:map<i16, i32> parameters, //频道参数
}  
struct getChannelConfigRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:map<i16, bool> options, //频道开关
    6:map<i16, i32> parameters, //频道参数
}
/*频道管理模块接口 结束*/
/*马甲管理接口 开始*/
enum thriftRolerOp
{
    NULOP,
    ADD,
    REMOVE,
    CHANGE,
}
enum thriftChannelRoler 
{
    NUL_ROLE = 0,
    VISITOR = 20, //VISITOR
    NORMAL = 25, //U
    DELETED = 50, //unuse
    TMPVIP = 66, //TMPVIP
    VIP = 88, //VIP
    MEMBER = 100, //R
    CMANAGER = 150, //CA
    PMANAGER = 175, //PA
    MANANGER = 200, //MAN
    VICE_OWNER = 230, //VO
    OWNER = 255, //OW
    KEFU = 300, //CS
    POLICE = 400, //WJ
    SA = 1000, //SA
}
struct updateUserRolerReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:i64 uid, //需要修改马甲的用户ID
    5:thriftRolerOp op, //操作类型
    6:thriftChannelRoler roler, //修改后的目标马甲
}
/*马甲管理接口 结束*/
/*秩序管理模块接口 开始*/
struct kickUserReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:list<i64> uids, //被踢用户uid列表
    4:i32 time, //踢人时间,单位秒
    5:string reason, //踢人原因
}
struct kickUserRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //踢出成功的uid列表
    4:list<i64> failUids, //踢出失败的uid以及原因
}
struct resetUserKickReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:list<i64> uids, //解踢用户列表
}
struct resetUserKickRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //踢出成功的uid列表
    4:list<i64> failUids, //踢出失败的uid以及原因
}
struct banUserReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:list<i64> uids, //被封uid列表
    4:bool ban, //ban:true-封禁,false-解封
    5:string reason, //被封原因
}
struct banUserRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //踢出成功的uid列表
    4:list<i64> failUids, //踢出失败的uid以及原因
}
struct disableUserTextReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:list<i64> uids, //禁止在频道内发送文字的uid列表
    5:bool disable,  //disable:true-禁止发言,false-允许发言
    6:string reason, //禁止用户发言的原因
}
struct disableUserTextRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //禁言成功的uid列表
    4:list<i64> failUids, //禁言失败的uid列表
}
struct disableUserVoiceAllPlatformReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:list<i64> uids, //禁止全网语音的uid列表
    3:bool disable, //disable:true-禁止语音,false-允许语音
    4:i64 time, //禁止全网语音的时间,单位秒
}
struct disableUserVoiceAllPlatformRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //禁语音成功的uid列表
    4:list<i64> failUids, //禁语音失败的uid列表
}
struct disableChannelTextReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:i32 op,  //op:true-禁止发言,false-允许发言
}
struct getDisableTextUsersReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
}
struct getDisableTextUsersRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
    4:string retstr, //通用返回提示信息
    5:list<i64> uids, //禁言的用户uid列表
}
struct isDisableTextUserReq
{
    1:AuthorizeMsg authmsg,//鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:list<i64> uids, //查询的用户uid列表
}
struct isDisableTextUserRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:map<i64, bool> successUids, //查询成功的uid列表
    4:list<i64> failUids, //查询失败的uid列表
}
/*秩序管理模块接口 结束*/
/*白名单/黑名单模块接口 开始*/
struct setUserSpeakableReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:list<i64> uids, //白名单uid列表
    5:bool bset, //bset:true-设置,false-解除设置
} 
struct setUserSpeakableRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //设置成功的uid列表
    4:list<i64> failUids, //设置失败的uid列表
}
struct syncUserSpeakableReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号
    4:list<i64> uids, //白名单用户uid列表
}
struct syncUserSpeakableRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //同步成功的uid列表
    4:list<i64> failUids, //同步失败的uid列表
} 
struct getSubChannelUserWhiteListReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 subsid, //子频道号
}  
struct getSubChannelUserWhiteListRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //返回码
    4:string retstr, //返回信息
    5:list<i64> uids, //白名单用户uid列表
}
struct addSubChannelWhiteListUserReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 subsid, //子频道号
    3:list<i64> uids, //白名单用户uid列表
}
struct addSubChannelWhiteListUserRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //添加成功的uid列表
    4:list<i64> failUids, //添加失败的uid列表 
} 
struct delSubChannelWhiteListUserReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 subsid, //子频道号
    3:list<i64> uids, //白名单用户uid列表
}
struct delSubChannelWhiteListUserRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:list<i64> successUids, //删除成功的uid列表
    4:list<i64> failUids, //删除失败的uid列表
}

/*白名单/黑名单模块接口 结束*/

/*临时信息接口 开始*/
struct tempInfoReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 topsid, //顶级频道号
    3:i64 subsid, //子频道号   
}

struct tempInfoRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
    4:string retstr, //通用返回提示信息
    5:list<i64> authUids, //加密频道已授权用户列表
    6:list<i64> kickoffUids, //被踢出子频道用户列表
    7:list<i64> disableTextUids, //禁止文字用户列表
    8:list<i64> disableVoiceUids, //禁止说话用户列表
    9:list<i64> disableTextSubsids, //禁止文字子频道列表
    10:list<i64> disableVisitorTextSubsids, //禁止游客文字子频道列表
    11:list<i64> speakableUids, //语音白名单
}
/*临时信息接口 结束*/

/*查询阿里云日志接口 开始*/
struct queryAliLogReq
{
    1:AuthorizeMsg authmsg, //鉴权信息,必选
    2:i64 serviceNanme, //查询的服务
    3:i64 from, //查询开始时间点(精度为秒,从 1970-1-1 00:00:00 UTC 计算起的秒数)。
    4:i64 to, //查询结束时间点(精度为秒,从 1970-1-1 00:00:00 UTC 计算起的秒数)。
    5:string topic, //查询日志主题
    6:string query, //查询日志表达式
    7:i64 line, //请求返回的最大日志条数。取值范围为 0~100,默认值为 100。
    8:i64 offset, //请求返回日志的起始点。取值范围为 0 或正整数,默认值为 0。
    9:bool reverse, //是否按日志时间戳逆序返回日志。true 表示逆序,false 表示顺序,默认值为 false。
}
struct queryAliLogRes
{
    1:i32 rescode, //调用结果码,默认为0,必选
    2:map<string,string> keyvalue, //扩展,必选
    3:i32 retcode, //通用返回码
    4:string retstr, //通用返回提示信息
    5:string status, //查询结果的状态。可以有 Incomplete 和 Complete 两个选值,表示本次是否完整。
    6:i64 count, //当前查询结果的日志总数。
    7:string result, //josn格式查询结果
}
/*查询阿里云日志接口 结束*/

service ChannelService
{
	/*保活(检查连通性)开始*/
	CommonRes chanif_ping(1:pingReq req) //保活(检查连通性)
	/*保活(检查连通性)结束*/
	/*麦序模块接口 开始*/
	CommonRes chanif_topFirst(1:topFirstReq req) //置为首麦
	CommonRes chanif_kickoffQueue(1:kickoffQueueReq req) //踢出麦序
	CommonRes chanif_joinQueue(1:joinQueueReq req) //加入麦序
	CommonRes chanif_muteQueue(1:muteQueueReq req) //控麦
	CommonRes chanif_disableQueue(1:disableQueueReq req) //禁麦
	CommonRes chanif_setTimeQueue(1:setTimeQueueReq req) //设置首麦时间
	CommonRes chanif_settopFirstQueue(1:settopFirstQueueReq req) //置为首麦,麦序上其他用户顺序不变
	getQueueRes chanif_getQueue(1:getQueueReq req) //获取麦序列表
	/*麦序模块接口 结束*/
	/*公屏模块接口 开始*/
	CommonRes chanif_sendTextChat(1:sendTextChatReq req) //发送公屏
	/*公屏模块接口 结束*/
	/*在线模块接口 开始*/
	CommonRes chanif_robotLogin(1:robotLoginReq req) //增加频道人数(机器人)
	CommonRes chanif_robotLogout(1:robotLogoutReq req) //减少频道人数(机器人)
    CommonRes chanif_setChannelUserCount(1:setChannelUserCountReq req) //设置频道在线人气值 国内外有差异
	/*在线模块接口 结束*/
	/*频道信息模块接口 开始*/
	getChannelInfoRes chanif_getChannelInfo(1:getChannelInfoReq req) //获取频道信息
	CommonRes chanif_updateChannelInfo(1:updateChannelInfoReq req) //更新频道信息
	/*频道信息模块接口 结束*/
    /*用户信息模块接口 开始*/
    /*用户信息模块接口 结束*/
	/*频道管理模块包括频道(顶级/子级)创建/解散、频道冻结锁定、频道开关*/
	/*频道管理模块接口 开始*/
	CommonRes chanif_createSubChannel(1:createSubChannelReq req) //创建子频道
	CommonRes chanif_dismissSubChannel(1:dismissSubChannelReq req) //解散子频道
    CommonRes chanif_setJiedai(1:setJiedaiReq req) //设置接待频道
	createTempChannelRes chanif_createTempChannel(1:createTempChannelReq req) //分配临时频道
	CommonRes chanif_freezeChannel(1:freezeChannelReq req) //冻结频道(禁止进入并踢出当前在频道里用户)
	CommonRes chanif_unfreezeChannel(1:unfreezeChannelReq req) //解冻频道
	loadFrozenChannelRes chanif_loadFrozenChannel(1:loadFrozenChannelReq req) //获取全量冻结频道
	isFrozenChannelRes chanif_isFrozenChannel(1:isFrozenChannelReq req) //查询频道是否冻结
	CommonRes chanif_lockChannel(1:lockChannelReq req) //锁定频道(禁止进入不踢出当前在频道里用户)
	CommonRes chanif_unlockChannel(1:unlockChannelReq req) //解除频道
	loadLockedChannelRes chanif_loadLockedChannel(1:loadLockedChannelReq req) //获取全量锁定频道
	isLockedChannelRes chanif_isLockedChannel(1:isLockedChannelReq req) //查询频道是否锁定
	CommonRes chanif_addMIITControlList(1:addMIITControlListReq req) //添加工信部管制用户
	CommonRes chanif_delMIITControlList(1:delMIITControlListReq req) //删除工信部管制用户
    CommonRes chanif_updateChannelConfig(1:updateChannelConfigReq req) //更新频道开关
    CommonRes chanif_removeChannelConfig(1:removeChannelConfigReq req) //删除频道开关
    getChannelConfigRes chanif_getChannelConfig(1:getChannelConfigReq req) //查询频道开关
	/*频道管理模块接口 结束*/
    /*马甲管理接口 开始*/
    CommonRes chanif_updateUserRoler(1:updateUserRolerReq req) //更新用户马甲
    /*马甲管理接口 结束*/
	/*秩序管理模块包括踢人和解除踢人、 封禁、 个人(频道)文字禁言、 查询频道文字禁言列表、 查询用户是否被文字禁言*/
	/*秩序管理模块接口 开始*/
	kickUserRes chanif_kickUser(1:kickUserReq req) //踢人
	resetUserKickRes chanif_resetUserKick(1:resetUserKickReq req) //解除踢人
	banUserRes chanif_banUser(1:banUserReq req) //封禁ID
	disableUserTextRes chanif_disableUserText(1:disableUserTextReq req) //个人文字禁言
    disableUserVoiceAllPlatformRes chanif_disableUserVoiceAllPlatform(1:disableUserVoiceAllPlatformReq req) //全网个人语音禁言
	/*秩序管理模块接口 结束*/
	/*白名单/黑名单模块接口 开始*/
	setUserSpeakableRes chanif_setUserSpeakable(1:setUserSpeakableReq req) //设置语音白名单
	syncUserSpeakableRes chanif_syncUserSpeakable(1:syncUserSpeakableReq req) //重置语音白名单
    getSubChannelUserWhiteListRes chanif_getSubChannelUserWhiteList(1:getSubChannelUserWhiteListReq req) //获取子频道用户白名单
    addSubChannelWhiteListUserRes chanif_addSubChannelWhiteListUser(1:addSubChannelWhiteListUserReq req) //添加子频道用户白名单用户
    delSubChannelWhiteListUserRes chanif_delSubChannelWhiteListUser(1:delSubChannelWhiteListUserReq req) //删除子频道用户白名单用户
	/*白名单/黑名单模块接口 结束*/

    /*临时信息接口 开始*/
    tempInfoRes chanif_getTempInfo(1:tempInfoReq req) //获取临时信息
    /*临时信息接口 结束*/

    /*查询阿里云日志接口 开始*/
    queryAliLogRes chanif_queryAliLog(1:queryAliLogReq req) //查询阿里云日志
    /*查询阿里云日志接口 结束*/
}

This snippet took 0.03 seconds to highlight.

Back to the Entry List or Home.

Delete this entry (admin only).