功能描述

该接口可以将指定的云信账号设置为免打扰。

设置免打扰后，当被设为免打扰的用户发送消息给自己时，不会触发在线消息提醒和离线推送的通知栏。

每个账号可设置免打扰的用户上限为 3000。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

POST https://open.yunxinapi.com/im/v2/mute_contacts

Header

请求 Header 的参数说明请参见 请求 Header。

请求体参数

参数名称	类型	是否必选	描述
account_id	String	必选	发起免打扰操作的云信账号 ID。
contact_account_id	String	必选	需要被设置为免打扰的云信账号 ID。

请求体示例

json{
    "account_id": "apiv2test",
    "contact_account_id": "apiv2test2"
}

响应

Header

响应 Header 的参数说明请参见 响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

json{
  "code": 200,
  "msg": "success",
  "data": {}
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
101301	IM 未开通	IM disabled
102404	用户不存在	account not exist
105429	不允许对自己进行免打扰操作	self mute operation not allowed
105435	免打扰列表超出上限	mute list limit exceeded
500	服务器内部错误	internal server error