delete contact book

删除通讯录条目（deleteContactBook）

使用通讯录 API 从通讯录中删除特定用户的条目。

删除后，用户的电话号码和 BSUID 不会再包含在业务资产组合中任何业务电话号码的 Webhook Payload 中，除非该电话号码处于 30 天缓存期，或新的互动触发了新的通讯录条目。

• URL：https://api2.nxcloud.com/api/wa/deleteContactBook
• Method：POST
• Content-Type：application/json
• 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

Header 参数

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（毫秒），服务端允许客户端请求最大时间误差为 60 秒
bizType	String	是	2	WhatsApp 业务类型，固定值 2
action	String	是	mt	WhatsApp 业务操作，固定值 mt
sign	String	是	6e9506557d1f289501d333ee2c365826	API 入参参数签名，见鉴权文档

Body 参数

参数名	类型	必选	示例值	说明
appkey	String	是	5pLzo3eb	应用 appkey
business_phone	String	是	85238533859	商户手机号码（需带国码）
messaging_product	String	是	whatsapp	消息通道，固定值 whatsapp
bsuid	String	是	CN.736657536200390	要删除的通讯录条目的 BSUID

BSUID 规则

1. 必须使用标准 BSUID 格式，例如：US.13491208655302741918。
2. BSUID 必须与业务电话号码属于同一业务资产组合。
3. 不支持父级 BSUID。

请求示例

{
  "appkey": "5pLzo3eb",
  "business_phone": "85238533859",
  "messaging_product": "whatsapp",
  "bsuid": "CN.736657536200390"
}

响应参数

参数名	类型	说明
code	Integer	结果编码
data	data Object	请求结果（可能包含下游 error 对象）
message	String	请求结果说明

data Object

参数名	类型	说明
success	Boolean	如果请求处理成功，将设置为 true
deleted	Boolean	- 若通讯录条目存在且被删除：true - 若未找到指定 BSUID 的条目：false
error	error Object	错误说明

响应示例

成功示例

{
  "code": 0,
  "data": {
    "deleted": true,
    "success": true,
    "messaging_product": "whatsapp"
  },
  "message": "success"
}

请求失败示例：bsuid 有误

{
  "code": 0,
  "data": {
    "error": {
      "code": 2.0,
      "message": "Service temporarily unavailable",
      "type": "FacebookApiException",
      "is_transient": true,
      "fbtrace_id": "APrUkLmuDDFiCMKWx0cZK-y"
    }
  },
  "message": "success"
}

失败示例：参数错误（缺少 bsuid）

{
  "code": 9000,
  "data": null,
  "message": "bsuid not null"
}

响应码说明

code	message	说明
0	success	请求已被服务端受理，若 data.error 非空请按下游错误处理
-1	failure	系统异常
1000~100X	鉴权问题	详情查看 API 鉴权部分
9000	参数异常	参数遗漏或格式错误
9001	系统业务错误	请联系技术人员排查
9002	商户手机号错误	请确认商户号码是否属于 WhatsApp 号码
10003	该 WhatsApp 号码未绑定应用	请先完成应用与号码绑定

对接注意事项

1. 本接口为删除通讯录条目接口，当前实现按 POST 调用。
2. bsuid 为必填，未传会返回参数错误。
3. 建议业务成功判定条件：
   • code == 0
   • 且 data.error 不存在
4. deleted=false 且 success=true 表示请求成功但未命中可删除条目。