该接口可以分页查询指定账号的黑名单列表，列表中包含被该账号列入黑名单的账号 ID。

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/block_contacts

Header

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

查询参数

参数名称	类型	是否必选	描述
account_id	String	必选	发起分页查询操作的云信账号 ID。
page_token	String	可选	分页标识符（标识查询位置索引的字符串值），如果为空，则默认从第一条记录开始查询。对应上次分页查询返回的 next_token 值。
limit	String	可选	单页查询的数量上限，默认和最大值都为 100。

响应

Header

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

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
+ data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否还有更多数据。	否
next_token	String	分页标识符。	否
+ items	Array of strings	返回的黑名单账号信息。	否
contact_account_id	String	黑名单中的云信账号。	否

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": true,
        "next_token": "1236465465",
        "items": [
            "accid1",
            "accid2"
        ]
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
101301	IM 未开通	IM disabled
102404	用户不存在	account not exist
500	服务器内部错误	internal server error