Appearance
设置公告群待办
将群公告消息设置为群待办,或撤回已设置的公告群待办。
接口地址: POST /roomTodo
前置条件
- 微信实例已登录,并已获得可用的
wId。 - 当前微信实例仍在目标群聊中,并具备设置群待办权限。
- 已成功发布群公告,并从公告消息回调中取得
newMsgId。 - 撤回群待办时需要传入设置待办成功后返回的
sign。
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
wId | 是 | string | 登录实例标识 |
chatRoomId | 是 | string | 群 ID |
newMsgId | 是 | int | 群公告消息 ID,设置群公告成功后由回调返回 |
operType | 是 | int | 0 设置群待办,1 撤回群待办 |
sign | 否 | int | 撤回时必传;设置待办成功后返回本字段 |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
code | string | 1000 成功,1001 失败 |
message | string | 反馈信息 |
data | object/null | 成功时可能返回撤回所需信息,失败时通常为空 |
sign | int | 撤销密钥,设置待办成功后用于后续撤回 |
请求示例
json
{
"wId": "0000016f-a340-c2d7-0003-6ab83bc1e64a",
"chatRoomId": "24187765053@chatroom",
"newMsgId": 123412341,
"operType": 0
}成功响应
json
{
"message": "成功",
"code": "1000",
"data": null
}错误响应
json
{
"message": "失败",
"code": "1001",
"data": null
}使用建议
- 群待办会影响群内成员提醒,建议仅对重要公告使用。
- 业务系统应保存设置待办成功后返回的
sign,否则后续无法撤回该待办。 - 建议按
chatRoomId + newMsgId做幂等处理,避免重复设置同一条公告待办。
