ユーザーのWhatsApp IDの本人確認

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

通信相手のユーザーが変わった可能性がある場合に、WhatsAppから通知を受け取ることができます。この/v1/contactsエッジを使って、ユーザーIDを管理します。詳しくは、WhatsApp BusinessのID変更について理解するをご覧ください。

WhatsAppから送信されるシステム通知の詳細については、インバウンドシステムメッセージ - 例: ユーザーが変わった可能性がある場合を参照してください。システム通知への応答はビジネスによって管理されます。

読み取り

このエンドポイントにGETを呼び出し、ユーザーの最新のIDハッシュを取得します。

例

リクエスト:

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

成功した場合、リクエストには200 OKが返され、メッセージ本文にはcontactsオブジェクトが含まれます。例えば、contactsオブジェクトを含む完全な応答は次のようになります。

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

返されるフィールド

contacts応答オブジェクトには、ユーザーのIDに関する次の情報が含まれています。

作成

このエンドポイントにPUT呼び出しを行い、最新のuser_identity_changedシステム通知に対して確認を行います。

アプリケーションの設定でshow_security_notificationsの設定が有効になっている場合は、user_identity_changed通知を受信するとidentity API呼び出しが成功するまで、そのユーザーへの送信メッセージはすべてブロックされます。

例

リクエスト:

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

成功した場合、200 OKが返され、メッセージ本文はnullまたは{}になります。

パラメーター