Метод getContact
меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод getContact

Получение информации об одном контакте.

Принцип использования

Синтаксис и URL для вызова метода
https://api.unisender.com/en/api/getContact?format=json&api_key=KEY&email=EMAIL
Аргументы
api_key* Ключ доступа к API.
email* E-mail адрес. Возвращает данные контакта по заданному значению этого параметра.
include_lists Вывод информации о списках, в которые добавлен контакт. Параметр принимает значение 1 или 0.
include_fields Вывод информации о дополнительных полях контакта. Параметр принимает значение 1 или 0.
include_details Вывод дополнительной информации о контакте. Параметр принимает значение 1 или 0.
Возвращаемое значение
JSON-объект со следующими полями:
email Перечень данных контакта:

Поля параметра email
email Email адрес контакта.
added_at Время создания контакта в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC.
status Статус email адреса. Возможные значения полей:

  • new — новый.
  • invited — отправлено приглашение со ссылкой подтверждения подписки, ждём ответа, рассылка по такому адресу пока невозможна.
  • active — активный адрес, возможна рассылка.
  • inactive — адрес отключён через веб-интерфейс, никакие рассылки невозможны, но можно снова включить через веб-интерфейс.
  • unsubscribed — адресат отписался от всех рассылок.
  • blocked — адрес заблокирован администрацией нашего сервиса (например, по жалобе адресата), рассылка по нему невозможна. Разблокировка возможна только по просьбе самого адресата.
  • activation_requested — запрошена активация адреса у администрации UniSender, рассылка пока невозможна.
availability Доступность e-mail адреса. Возможные значения:

  • available — адрес доступен.
  • unreachable — адрес недоступен.
  • temp_unreachable — адрес временно недоступен.
  • mailbox_full — почтовый ящик переполнен.
  • spam_rejected — письмо сочтено спамом сервером получателя. Через несколько дней этот статус будет снят.
  • spam_folder — письмо помещено в спам самим получателем.
last_send_datetime Время последней отправки письма на данный email адрес в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC. Если данного события еще не было, значение будет — null.
Значение возвращается при использовании параметра inlcude_details.
last_delivery_datetime Время последней доставки письма на данный email адрес в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC. Если данного события еще не было, значение будет — null.
Значение возвращается при использовании параметра inlcude_details.
last_read_datetime Время последнего прочтения письма данным email адресом в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC.
Если данного события еще не было, значение будет — null.
Значение возвращается при использовании параметра inlcude_details.
last_click_datetime Время последнего перехода по ссылке из письма данным email адресом в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC.
Если данного события еще не было, значение будет — null.
Значение возвращается при использовании параметра inlcude_details.
rating Рейтинг имейл адреса, показывающий активность контакта. Значение принимает вид от “0.0” до “5.0”. Если не было ни одной отправки, значение будет — null.
Значение возвращается при использовании параметра inlcude_details.
lists Данные по спискам, вызванные параметром include_lists

Поля параметра lists
id Идентификатор списка.
status Статус email-адреса в списке. Перечень статусов
added_at Время добавления контакта в список в формате «ГГГГ-ММ-ДД чч:мм:сс» в UTC.
fields Перечень дополнительных полей и их значения, вызванные параметром include_fields.
{
  "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"
   }
  ]
 }
}

Примеры формирования URL-запроса

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»
(0)