用户 WhatsApp 编号身份

/v1/contacts/{users-whatsapp-id}/identity

当您正在与之沟通的用户可能发生更改时,您可能会收到来自 WhatsApp 的通知。使用此 /v1/contacts 连线可管理用户身份。如需了解更多信息,请参阅了解 WhatsApp Business 的身份更改

有关 WhatsApp 发送的系统通知的更多信息,请参阅入站系统消息 — 示例:用户可能发生更改。对系统通知的响应由您的公司管理。

读取

向此端点发出的 GET 调用会检索用户的最新身份哈希值。

示例

请求:

GET /v1/contacts/users-whatsapp-id/identity

如果响应成功,您的请求会返回 200 OK,以及包含 contacts 对象的消息正文。例如,包含 contacts 对象的完整响应可能与以下内容类似:

{
    "contacts":
    {
        "hash": "UKD6Y/5SqDU=",
        "created_timestamp": 1600132094000,
        "acknowledged": true 
    }
}
  

返回的字段

contacts 响应对象包含关于用户身份的以下信息。

名称描述

acknowledged

类型:字符串

最新 user_identity_changed 系统通知的确认状态。

created_timestamp

类型:整数

WhatsApp Business API 客户端检测到用户可能发生更改时的时间戳。

hash

类型:字符串

最新 user_identity_changed 系统通知的标识符。

创建

向此端点发出 PUT 调用,来确认最新的 user_identity_changed 系统通知。

如果在应用程序设置中启用了 show_security_notifications 设置,则在收到 user_identity_changed 通知并成功进行 identity API 调用之前,对该用户的所有传出消息都将被屏蔽。

示例

请求:

PUT /v1/contacts/users-whatsapp-id/identity
  {
    “hash”: “Rc/eg9RQ0JA=”
  }

成功响应为包含 null{} 消息正文的 200 OK

参数

名称描述

hash

类型:字符串

此联系人收到的最新 user_identity_change 系统通知的标识符