Skip to content

群保存/取消到通讯录

将指定微信群聊保存到通讯录,或从通讯录中移除。

接口地址: POST /showInAddressBook

前置条件

  • 微信实例已登录,并已获得可用的 wId
  • 当前微信实例仍在目标群聊中,并已获得可用的 chatRoomId
  • 已确认目标操作是保存到通讯录还是从通讯录移除。

请求参数

参数名必选类型说明
wIdstring登录实例标识
chatRoomIdstring群 ID
flagint3 保存到通讯录,2 从通讯录移除

响应参数

参数名类型说明
codestring1000 成功,1001 失败
messagestring反馈信息
datanull成功或失败时通常为空

请求示例

json
{
  "wId": "349be9b5-8734-45ce-811d-4e10ca568c67",
  "chatRoomId": "24343869723@chatroom",
  "flag": 3
}

成功响应

json
{
  "message": "成功",
  "code": "1000",
  "data": null
}

错误响应

json
{
  "message": "失败",
  "code": "1001",
  "data": null
}

使用建议

  • 保存到通讯录适合长期运营或高频触达的群聊。
  • 从通讯录移除不会退出群聊,只影响当前微信实例的通讯录展示。
  • 业务系统应保存目标期望状态,避免重复提交同一个 flag 操作。