Appearance
群保存/取消到通讯录
将指定微信群聊保存到通讯录,或从通讯录中移除。
接口地址: POST /showInAddressBook
前置条件
- 微信实例已登录,并已获得可用的
wId。 - 当前微信实例仍在目标群聊中,并已获得可用的
chatRoomId。 - 已确认目标操作是保存到通讯录还是从通讯录移除。
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
wId | 是 | string | 登录实例标识 |
chatRoomId | 是 | string | 群 ID |
flag | 是 | int | 3 保存到通讯录,2 从通讯录移除 |
响应参数
| 参数名 | 类型 | 说明 |
|---|---|---|
code | string | 1000 成功,1001 失败 |
message | string | 反馈信息 |
data | null | 成功或失败时通常为空 |
请求示例
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操作。
