How to retrieve contact's information

How to retrieve contact's information

Requirements


In order to retrieve contact's information, the following conditions must be complied:

  • a THRON Custom Application Manager must be used to retrieve contact's information, and it has to own the permission to manage contacts.
  • Make sure you know the contactId, which can retrieved through a list request by providing at least one known identity (see paragraph below)

 

Retrieve contactId

Given that you know at least one identity provided by the contact (e.g. its email), you can invoke a list request, which is a POST request with the following form:

//[clientId]-view.thron.com/contactunit/xcontact/resources/contact/list/[clientId]

The headers that should be used for the request are:

  • Content-Type: application / json
  • X-TokenId: XXXXX (using the token obtained through the login)

In the body you can paste the following JSON, filling required parameters:

{
  "criteria": {
    "iks": [
      {
        "key": "<label of the known identity here>",
        "value": "<value of the known identity here>"
      }
    ]
  }
}

 In the response you will get the id parameter which is the actual contactId.

Retrieve information


Specific web service dedicated to the retrieval of contact's information is detail, which is included within the contact package of xcontact.
The URL of the web service is structured as follows:
 

//[clientId]-view.thron.com/contactunit/xcontact/resources/contact/detail/[clientId]?contactId=[contactId]

 
Where [clientId] is the domain name used to access THRON(usually company name).

The headers that should be used for the request, which is a GET are:
  • Content-Type: application / json
  • X-TokenId: XXXXX (using the token obtained through the login)
Additional query parameters are:
  • clientId
  • contactId
In the response you will be able to read the following contact's information (only the most common are listed here, for the complete list please visit our Developer Center):
 
  • itags: an array of objects, each one representing a specific tag linked to the contact. Each object contains the following set of information:
    • sources: an object representing the entity that created the specific tag. The object has the following information:
      • stype: the type of entity that created the specific tag, can be USER, APPLICATION or ENGINE.
      • id: the identifier of the entity that created the tag, can be a username, an appId or the name of the engine.
    • classificationId: the ID of the classification containing the specific tag.
    • id: the actual identifier of the tag.
  • keys: an array of objects representing the identities provided by the contact. Each object has the following information:
    • key: the label of the identity (e.g. email).
    • value: the actual value of the identity.
  • createdDate: the date on which the contact has been created, expressed with ISO-8601 timestamp.
  • accessedDate: the date on which the contact has performed the latest access to THRON, expressed with ISO-8601timestamp.
  • oldIds: an array containing all the deviceIds that were linked to the contact.
  • contactType: the type of contact, can either be ANONYMOUS or IDENTIFIED.
  • name: the fullname of the contact.
  • id: the actual contactId.
  • devices: an array of objects representing all the devices used by the contact. Each object has the following set of information:
    • ip: the IP address of the device.
    • createdDate: the date on which the device has been created, expressed with ISO-8601 timestamp.
    • accessedDate: the date on which the device has performed its latest access to THRON, expressed with ISO-8601 timestamp.
    • ua: the user agent of the device.
    • id: the deviceId.
 
Was this article helpful?
0 out of 0 found this helpful

Have more questions?

SUBMIT A REQUEST

Hai altre domande?

INOLTRA UNA RICHIESTA

Comments