Email Collection

Introduction

Email collection is a feature that allows the collection of email addresses from users who connect to your network.

This is presented to the user as an email input field in the captive portal. Depending on the configuration, this may be required or optional for the user to enter.

You can also configure a CID (Campaign ID) to collect email addresses for a specific campaign.

Exporting Email Addresses

Via Unwired Edge Cloud Console (CSV)

Navigate to Portal Editor -> Email export.
Select the CID (Campaign ID) and the date range for the email addresses you want to export.
- Selection all will export email addresses for all campaigns.
This will generate a CSV file with the email addresses and other information.

Via API

Prerequisites

Please refer to the API documentation for the authentication process.

GraphQL

GraphQL Document:

query export_emails(
    $customer_id: String,
    $email_cid: String,
    $time_start: DateTime,
    $time_end: DateTime
  ) {
  export_emails(customer_id: $customer_id, email_cid: $email_cid, time_start: $time_start, time_end: $time_end) {
    error {
      error_code
      error_message
    }
    emails {
      email
      email_cid
      date_created
      language
      country
      ap_mac
      usages {
        collection_id
        collection_terms
      }
    }
  } 
}

Variables:

{
    "customer_id": "customer_id",
    "email_cid": "email_cid",
    "time_start": "2021-01-01T00:00:00Z",
    "time_end": "2021-12-31T23:59:59Z"
}