ZOLOZZOLOZDOCS

Remove Item

概览

  • API URL：/api/v1/zoloz/blacklist/removeitem
  • API 描述：该接口用于从目标黑名单列表中删除一条记录。

说明：该接口支持重复调用，即符合幂等性。

请求参数

字段名称

数据类型

最大长度

是否必填

描述

示例值

bizId

String

32

是

业务ID，业务的唯一标识，用于追踪业务。例如，商户业务相关数据库中的序列号。

说明：ZOLOZ服务器不检查该字段的值是否唯一。为了更便捷地追踪业务，建议开启商户服务器，并确保业务ID的唯一性。

"2017839040588699"

itemType

String

8

是

要删除的黑名单记录的类型。取值如下：

  • FACE：人脸黑名单。
  • DEVICE：设备黑名单。
  • CERT：证件黑名单。

"FACE"

itemId

String

64

是

要删除的黑名单记录ID。

"86451b883c80372"

返回参数

字段名称

数据类型

必须返回

描述

示例值

result

Result

是

API请求结果，包含结果状态、结果码和结果消息。

{ "resultCode":"SUCCESS", "resultMessage":"Success", "resultStatus":"S" }

removedItemId

String

否

已删除的黑名单记录ID。当记录删除成功时，才返回该字段。

"86451b883c80372"

处理结果

API通用结果码

有关通用结果码的完整列表，请参见API通用结果码。

API特有结果码

Blacklists removeitem API的结果码见下表。

结果码

结果状态

描述

SUCCESS

S

API调用成功。

INVALID_ARGUMENT

F

输入参数无效。关于无效参数的详细信息，请查看返回的resultMessage。

BLACKLIST_ITEM_NOT_FOUND

F

请求的黑名单记录不存在。

SYSTEM_ERROR

F

其他内部错误。有关错误详情，请查看返回的resultMessage。

代码示例

请求示例

copy
{
  "bizId": "2017839040588699",
  "itemId": "86451b883c80372",
  "itemType": "FACE" 
}

返回示例

copy
{
  "removedItemId":"86451b883c80372",
  "result":{
    "resultCode":"SUCCESS",
    "resultMessage":"Success",
    "resultStatus":"S"
  }
}