Airship Developers
HomeAcademy
  • Welcome
  • Rest API
    • Overview
    • Authentication
    • API Reference
    • Accreditation
  • Basics
    • Contacts
      • Write a contact
      • Append feedback
      • Append purchase history
      • Append booking data
      • Append WiFi data
      • Append Stay data
      • Append Loyalty data
      • Append ticket data
      • Append other PoPs
    • Bookings
      • Booking Search by reference
      • Booking Search by data_element
      • Booking Update
    • Search Contact
      • Search PoPs by contact
      • Search contact by Email, Mobile, Name
      • Search contact by voucher
    • Vouchers
      • Redeem voucher code
      • Check voucher code
      • Create Unique Code Group
    • Anonymous purchase data
      • Add anonymous purchase data
    • Units
    • Postman collection
  • SOAP API (legacy)
    • Overview
Powered by GitBook
On this page
  • Overview
  • Storing WIFI interactions
  • Example Payload
  1. Basics
  2. Contacts

Append WiFi data

Store WIFI Interaction history as you send contact data to us

Overview

Airship can store WIFI interaction history for each contact.

Having WIFI data attached to contacts is useful to measure and target recent or lapsed visitors based on their last visit.

Storing WIFI interactions

To store WIFI interactions, simply append a wifi_interactions object to your contact as you send it to us.

Value
Notes

datetime

The date / time of the WIFI interaction Required field

unit_id

The unit_id representing the physical location for which this WIFI interaction relates Required field

type

detected - This interaction type should be used when a user's device passively connects to the WiFi hotspot.

connected - This interaction type should be used once a user proactively views your captive portal. authenticated - This interaction type should be used once a user has provided the information required by the captive portal to connect to the Internet via your WiFi service. unknown - If your platform doesn't support the above connection types, use the unknown type Required field

hotspot_name

Text description of where the connection was made (i.e. Upstairs Bar)

Optional

mac_address

Unique device reference Optional

device_mime_type

Text description for the source of the WIFI interaction Required Field

Example Payload

{
"account_id": 3,
"email": "johnsmith@gmail.com",
//...etc...

    "wifi_interactions" :[
        {
            "datetime":"2022-01-01 12:00:00",
            "unit_id": "4",
            "type": "authenticated",
            "hotspot_name": "Bar 01",
            "mac_address": "01:A1:C1:11:C1:11",
            "device_mime_type": "Airship Splash page"
        }
    ]
}
PreviousAppend booking dataNextAppend Stay data

Last updated 1 year ago