Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

getContact method

Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Getting information about a contact (one contact only).

Principle of use

URL to call the method
https://api.unisender.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL
Аргументы
api_key* API access key.
email * Email address. Returns contact data by the given value of this parameter.
include_lists Displays information about the lists to which the contact has been added. The parameter takes the value 1 or 0.
include_fields Display information about additional contact fields. The parameter takes the value 1 or 0.
include_details Displays additional information about the contact. The parameter takes the value 1 or 0.
Return value
JSON object with the following fields:
email Contact information list:

Email parameter fields
email Email address of contact.
added_at The time the contact was created in the format “YYYY-MM-DD hh: mm: ss” in UTC.
status Email address status. The valid values are listed in the list of system fields below:

  • new — – new.
  • invited – invitation sent with a subscription confirmation link, waiting for an answer, mailing to this address impossible.
  • active – active address, mailing is possible.
  • inactive – address disabled via web interface, all mailings are impossible, can be again enabled via the web interface.
  • unsubscribed – addressee unsubscribed from all mailings.
  • blocked – address blocked by the administration of our service (for example, on the addressee’s complaint), mailing impossible. Unlocking is possible only at the request of the addressee.
  • activation_requested – requested activation of the address from the administration UniSender, mailing is not yet possible.
availability Availability of e-mail address. Possible values:

  • available — the address is available.
  • unreachable — address unavailable.
  • temp_unreachable — address temporarily unavailable.
  • mailbox_full — mailbox is full.
  • spam_rejected — The letter is considered spam by the recipient server. In a few days this status will be removed.
  • spam_folder — the letter is placed in spam by the recipient.
last_send_datetime The time of the last letter sent to this email address in the format “YYYY-MM-DD hh: mm: ss” in UTC. If this event has not yet been, the value will be – null.
The value is returned when using the inlcude_details parameter.
last_delivery_datetime The time of the last letter delivery to this email address in the format “YYYY-MM-DD hh: mm: ss” in UTC.
If this event has not yet been, the value will be – null.
The value is returned when using the inlcude_details parameter.
last_read_datetime The last time the message was read by this email address in the format “YYYY-MM-DD hh: mm: ss” in UTC.
If this event has not yet been, the value will be – null.
The value is returned when using the inlcude_details. parameter.
last_click_datetime The time of the last click on the link from the letter given by the email address in the format “YYYY-MM-DD hh: mm: ss” in UTC.
If this event has not yet been, the value will be – null.
The value is returned when using the inlcude_details parameter.
rating Rating email address showing the activity of the contact. The value takes the form from “0.0” to “5.0”
If there was no sending, the value will be – null.
The value is returned when using the inlcude_details. parameter.
lists List Data caused by the include_lists parameter

Lists parameter fields
id List id.
status The status of the email address in the list. List of statuses
added_at The time the contact was added to the list in the format “YYYY-MM-DD hh: mm: ss” in UTC.
fields List of additional fields and their values, caused by the include_fields parameter.
{
  "result":{
   "email":{
    "email":"localpart@example.com",
    "added_at": "2018-01-23T00:00:00.000Z",
    "status": "active",
    "availability": "available",
    "last_send_datetime": "2019-06-13T07:12:00.000Z",
    "last_delivery_datetime": "2019-06-13T07:12:00.000Z",
    "last_read_datetime": "2019-06-14T12:58:00.000Z",
    "last_click_datetime": "2019-06-14T12:59:00.000Z",
    "rating": 4.1
   },
   "fields": {
    "Name": "local part",
    "field2": "some value"
   },
   "lists":[
      {
       "id": "11235892",
       "status": "active",
       "added_at": "2018-01-23T00:00:00.000Z"
   },
   {  
       "id": "33567123",
       "status": "unsubscribed",
       "added_at": "2018-01-23T00:00:00.000Z"
   }
  ]
 }
}

Examples of forming the URL request

https://api.unisender.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL;
https://api.unisender.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL&include_lists=1&include_fields=1&include_details=1
Оцените, на сколько вам показалась полезной статья «getContact method»
(0)

Did we answer to your question?

0
0