Contacts

Contacts represent the resource associated with mobile users or contacts acquired via Experiences.

Contact object: example

The Contact object may differ depending on the specific API. You can explore the Contact object in the definition of each API endpoint.

{
      "cid":"string",
      "title":"string",
      "firstName":"string",
      "lastName":"string",
      "gender":"string",
      "birthDate":"string",
      "birthDay":"string",
      "age":"string",
      "country":"string",
      "zipCode":"string",
      "created":"string",
      "modified":"string",
      "email":"string",
      "emailVerified":true,
      "phone":"string",
      "phoneVerified":true,
      "signupMethod":"string",
      "externalIdentityId":"string",
      "username":"string",
      "locked":true,
      "organizationCid":"string",
      "locationCid":"string",
      "system":"string",
      "enabled":true,
      "type":"string",
      "locationName":"string",
      "personalId":"string",
      "externalSource":"string",
      "lastLogin":"string",
      "segmentCids":"string",
      "logins":0,
      "policies":[
        {
          "name":"string",
          "accepted":true
        }
      ],
      "segments":[
        {
          "cid":"string",
          "name":"string"
        }
      ],
      "extId":{
        "id":"string",
        "prop1":"string",
        "prop2":"string"
      },
      "metrics":{
        "frequencyMonthlyVisit":0,
        "compassTopLocation":"string",
        "compassTopLocationCount":0,
        "topFrequencyBuckets":"string",
        "lastVisitVenue":"string",
        "prefVisitWDay":"string",
        "lastVisitDateUtc":"string",
        "avgVisitLength":0,
        "countVisitedLocations":0,
        "prefVisitTimebucket":"string",
        "prefVisitTimeHour":"string",
        "lastVisitDateBusiness":"string",
        "countTotalVisits":0,
        "conversionRate":0,
        "avgDaysBetweenVisits":0
      }
    }

Endpoints

List all the Contacts of an organization matching the search parameters

Role: Organization Manager Scope: organization_read, customer_read

GEThttps://explore.cloud4wi.com//v2/customers/organizations/{cid}

Path parameters

cid*string

organization cid

Query parameters

Response

200default

The array of the customers

Body

application/json

generatedstring

totalCountnumber

countnumber

sIdstring

id used in the scrolling

customersarray of customerListResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/customers/organizations/{cid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "generated": "text",
  "totalCount": 0,
  "count": 0,
  "sId": "text",
  "customers": [
    {
      "cid": "text",
      "title": "text",
      "firstName": "text",
      "lastName": "text",
      "gender": "text",
      "birthDate": "text",
      "birthDay": "text",
      "age": "text",
      "country": "text",
      "zipCode": "text",
      "created": "text",
      "modified": "text",
      "email": "text",
      "emailVerified": false,
      "phone": "text",
      "phoneVerified": false,
      "signupMethod": "text",
      "externalIdentityId": "text",
      "username": "text",
      "locked": false,
      "organizationCid": "text",
      "locationCid": "text",
      "system": "text",
      "enabled": false,
      "type": "text",
      "locationName": "text",
      "personalId": "text",
      "externalSource": "text",
      "lastLogin": "text",
      "segmentCids": "text",
      "logins": 0,
      "policies": [
        {
          "name": "text",
          "accepted": false
        }
      ],
      "segments": [
        {
          "cid": "text",
          "name": "text"
        }
      ],
      "extId": {
        "id": "text",
        "prop1": "text",
        "prop2": "text"
      },
      "metrics": {
        "frequencyMonthlyVisit": 0,
        "compassTopLocation": "text",
        "compassTopLocationCount": 0,
        "topFrequencyBuckets": "text",
        "lastVisitVenue": "text",
        "prefVisitWDay": "text",
        "lastVisitDateUtc": "text",
        "avgVisitLength": 0,
        "countVisitedLocations": 0,
        "prefVisitTimebucket": "text",
        "prefVisitTimeHour": "text",
        "lastVisitDateBusiness": "text",
        "countTotalVisits": 0,
        "conversionRate": 0,
        "avgDaysBetweenVisits": 0
      }
    }
  ]
}

Get a Contact

Retrieve Contact profile by Id Role: Organization Manager Scope: organization_read, customer_read

GEThttps://explore.cloud4wi.com//v2/customers/{cid}

Path parameters

cid*string

id of the customer

Response

200

Data present

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/customers/{cid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List location Events of a Contact

Retrieve list of visits and WiFi connections including metadata such as date and duration. Role: Organization Manager Scope: organization_read, customer_read

GEThttps://explore.cloud4wi.com//v2/customers/{cid}/events

Path parameters

cid*string

id of the customer

Response

200

Data present

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/customers/{cid}/events', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List all devices of a Contact

Retrieve device information like WiFi MAC address, number of WiFi connections and last WiFi connection date on the device. Role: Organization Manager Scope: organization_read, customer_read

GEThttps://explore.cloud4wi.com//v2/customers/{cid}/devices

Path parameters

cid*string

id of the customer

Response

200

Data present

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/customers/{cid}/devices', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update the opt-ins of a Contact

For the custom opt-ins add the prefix "customs." to the policyKey. For example, if the custom opt-in has title "emailMarketing" to update it use the policyKey "customs.emailMarketing" Role: Organization Manager Scope: organization_write, customer_write

PUThttps://explore.cloud4wi.com//v1/customers/{cid}/policies

Path parameters

cid*string

id of the customer

Body

application/json

desc

policiesarray of policyUpdate (object)

Response

200207default

Update done.

Body

application/json

policyKeyboolean

the new value of the policyKey

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v1/customers/{cid}/policies', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200207default

{
  "policyKey": false
}

Delete a Contact

Delete a Contact by Id Role: Organization Manager Scope: organization_write, customer_write

DELETEhttps://explore.cloud4wi.com//v1/customers/{cid}

Path parameters

cid*string

id of the customer

Response

200default

Deleted done.

Body

application/json

statusstring

OK

generatedstring

date time of response

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v1/customers/{cid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "status": "text",
  "generated": "text"
}

List all WiFi Connections of a Contact

Retrieve WiFi connections of a specific Contact Id, including metadata such as duration, traffic, access point used Role: Organization Manager Scope: organization_read, customer_read

GEThttps://explore.cloud4wi.com//v2/customers/{cid}/accountings

Path parameters

cid*string

id of the customer

Response

200

Array with the accountings

Body

application/json

generatedstring

sIdstring

countnumber

connectionsarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://explore.cloud4wi.com//v2/customers/{cid}/accountings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "generated": "text",
  "sId": "text",
  "count": 0,
  "connections": [
    {
      "start": "text",
      "startBusiness": "text",
      "stop": "text",
      "stopBusiness": "text",
      "duration": 0,
      "traffic": 0,
      "locationName": "text",
      "locationId": "text",
      "apName": "text",
      "apId": "text",
      "latitude": 0,
      "longitude": 0,
      "macAddressClient": "text",
      "ipAddressClient": "text",
      "terminateCause": "text"
    }
  ]
}

Data example

Example of Contact object returned by the endpoint https://explore.cloud4wi.com//v2/customers/organizations/{cid}

{
   "generated":"2022-11-15T15:45:04Z",
   "totalCount":1,
   "count":1,
   "customers":[
      {
         "segments":[
            {
               "cid":"12d1f8713a1fecb953bcc64220813bc6",
               "name":"Loyal Customer"
            }
         ],
         "cid":"f4c6be2cebc56bf4b8a16a2d463d5b60",
         "title":null,
         "firstName":"Ivan",
         "lastName":"Muccini",
         "gender":"male",
         "birthDate":"1982",
         "birthDay":"01-29",
         "age":38,
         "country":"us",
         "zipCode":null,
         "created":"2022-07-21T17:58:35Z",
         "createdBusiness":"2022-07-21T17:58:35Z",
         "modified":"2022-11-15T05:19:43Z",
         "email":"[e-mail]",
         "emailVerified":false,
         "phone":"[phone]",
         "phoneNumber":"4156264284",
         "phonePrefix":"+1",
         "phoneVerified":false,
         "signupMethod":"passthrough",
         "externalIdentityId":null,
         "username":"RG1DXHXHMRTW",
         "locked":false,
         "organizationCid":"155d60f21dc1938562900a0e201d54f6",
         "locationCid":"ff808081803ff92a01820195deb26263",
         "system":"mobileapp",
         "enabled":true,
         "type":"guest",
         "locationName":"hiddden_SECUREWIFI.IO",
         "personalId":null,
         "externalSource":"Cloud4wi",
         "policies":[
            {
               "name":"termsOfUse",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"privacy",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"mktgCommunications",
               "accepted":true,
               "date":"2022-07-21T17:58:35.000Z",
               "version":"default"
            },
            {
               "name":"profiling",
               "accepted":false,
               "date":"2020-10-26T14:18:21.000Z",
               "version":"1.00"
            }
         ],
         "lastLogin":"2022-08-02T14:48:57.000Z",
         "logins":182,
         "metrics":{
            "frequencyMonthlyVisit":3.0897396143865636,
            "compassTopLocation":"ff808081803ff92a01821d4cfd856805",
            "compassTopLocationCount":12,
            "topFrequencyBuckets":"daily",
            "lastVisitVenue":"ff808081803ff92a01821d4cfd856805",
            "prefVisitWDay":2,
            "lastVisitDateUtc":"2022-08-02T14:54:36Z",
            "avgVisitLength":461.3333333333333,
            "countVisitedLocations":1,
            "prefVisitTimebucket":"afternoon",
            "prefVisitTimeHour":"15",
            "lastVisitDateBusiness":"2022-08-02T07:54:36Z",
            "countTotalVisits":12,
            "conversionRate":1,
            "avgDaysBetweenVisits":1.0909090909090908
         },
         "emailValid":null,
         "language":"it",
         "splashLanguage":"it",
         "genericCustomField":[
            {
               "key":"loyalty_card",
               "value":"9500000012143687"
            }
         ],
         "extId":{
            
         }
      }
   ]
}