功能描述

该接口可以将指定的云信账号列入黑名单。

列入黑名单后，对于操作者而言该账号无法发送消息给操作者。

每个账号可设置黑名单的上限为 3000。

调用频率

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

请求

URL

POST https://open.yunxinapi.com/im/v2/block_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
106429	不允许对自己进行黑名单操作	self blocklist operation not allowed
106435	黑名单数量超出上限	blocklist limit exceeded
500	服务器内部错误	internal server error