用戶 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 系統通知的識別碼