用戶 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 系統通知。

當您在收到 user_identity_changed 通知後成功執行 identity API 呼叫之前,如果應用程式設定中的 show_security_notifications 設定已啟用,則所有傳送至此用戶的已傳送訊息均會被封鎖。

範例

要求:

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

成功的回應為含有 null{} 訊息正本的 200 OK

參數

名稱說明

hash

類型:字串

就此聯絡人所接收的最近 user_identity_change 系統通知之識別資料