有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能说明

App 后台可以通过该回调实时查看用户创建话题的请求,同时后台也可以拒绝用户创建话题的请求。

注意事项

要启用回调,必须配置 URL,本条回调协议和创建群组之前回调协议的控制台开关为同一个,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 IM 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参考 第三方回调简介:安全考虑 文档。
话题功能需要在 控制台开通 后才能使用。

可能触发该回调的场景

App 用户通过客户端创建话题
App 管理员通过 REST API 创建话题

回调发生时机

即时通信 IM 后台准备创建话题之前。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为 https://www.example.com示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

请求参数说明

参数
说明
https
请求协议为 HTTPS,请求方式为 POST
回调 URL
SdkAppid
创建应用时在即时通信 IM 控制台分配的 SDKAppID
CallbackCommand
固定为:Group.CallbackBeforeCreateTopic
contenttype
固定值为 JSON
ClientIP
客户端 IP,格式如:127.0.0.1
OptPlatform
客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

请求包示例

{
"CallbackCommand": "Group.CallbackBeforeCreateTopic", // 回调命令
"Operator_Account": "leckie", // 操作者
"Type": "Community", // 群组类型
"Name": "MyFirstTopic" // 群组名称
}

请求包字段说明

对象
介绍
功能
CallbackCommand
String
回调命令
Operator_Account
String
发起创建话题请求的操作者 UserID
Type
String
代表创建话题所属的群组类型,这里为Community
Name
String
请求创建话题的名称

应答包示例

允许创建

允许用户创建话题。
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 允许创建
}

禁止创建

不允许用户创建话题,话题将不会被创建,同时给调用方返回错误码:10016
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 1 // 拒绝创建
}

应答包字段说明

字段
类型
属性
说明
ActionStatus
String
必填
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
必填
错误码,0为允许创建;1为拒绝创建,若业务希望使用自己的错误码拒绝用户新建话题,将错误码 ErrorCode 和 ErrorInfo 传递至客户端,请将错误码 ErrorCode 设置在 [10100, 10200] 区间内
ErrorInfo
String
必填
错误信息

参考

REST API:创建话题