Модель контакту

Детальна інформація про кожне поле Customer Object
Написано Микола
Оновлено 2 місяці тому

Customers API дозволяє отримувати, знаходити, створювати, оновлювати, позначати тегами або знімати теги, а також видаляти свої контакти. За потреби ви також можете передати контакту подію активності. Таким чином ви зможете повністю контролювати свої контакти в HelpCrunch.

Ось приклад відповіді для більшості методів Customer API:

{
    "id": 7831827,
    "name": "Hakim Zarakim",
    "email": "hzarakim@example.com",
    "userId": "example_22",
    "company": "example",
    "phone": null,
    "firstSeen": 1593547200,
    "lastSeen": 1593547200,
    "location": {
        "regionCode": "London",
        "countryCode": "EN",
        "city": "London"
    },
    "device": {
        "id": 28883192,
        "ip": "192.168.1.1",
        "timezone": "America/Los Angeles",
        "platform": "desktop",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.138 Safari/537.36"
    },
    "unsubscribed": false,
    "blocked": false,
    "source": "http://helpcrunch.com/blog/best-live-chat-software/",
    "referer": "https://www.google.com/",
    "locale": "en",
    "notes": "He has never heard about magic",
    "lastPage": "https://example.helpcrunch.com/v2/chats",
    "tags": [
        {
            "name": "Lead",
            "color": "#cсс"
        },
        {
            "name": "Paid",
            "color": "#c377e0"
        }
    ],
    "customData": {
            "subscription_status": "Active",
            "number_of_payments": 15,
            "last_paid_amount": 100.5,
            "last_payment_date": 2021-04-30 23:11:00,
            "last_payment_was_successful": true
        }
    ]
}

Нижче ви можете знайти детальну інформацію про кожне з полів Customer Object.

Поле Тип Опис
id Integer Унікальний ID контакту, наданий HelpCrunch
name String Ім'я контакту
email String Електронна адреса контакту
userId String

Власний унікальний ID контакту, який ви можете передати в HelpCrunch за допомогою режиму автентифікації користувача

company String Компанія контакту
phone String Номер телефону контакту
firstSeen Date (UNIX timestamp) Дата і час першого візиту контакту
lastSeen Date (UNIX timestamp) Дата та час останнього візиту контакту
location Object Об'єкт геолокації контакту. Містить рядки regionCode, countryCode та city.
device Object Об'єкт пристрою контакту. Містить унікальний id, ip address, timezone, platform ("desktop" чи "mobile") та userAgent.
unsubscribed Boolean Статус підписки електронної пошти контакту.  True - відписаний. False - підписаний.
blocked Boolean Заблоковані контакти взагалі не бачать віджет HelpCrunch. True - заблокований. False - розблокований.
source String URL-адреса, з якої контакт перейшов на ваш сайт
referer String Рядок HTTP Referrer
locale String Локаль контакту, яка визначає мову і регіон контакту
notes String Примітки щодо контакту. Доступні в профілі контакту
lastPage String Остання сторінка, на якій був контакт
tags Array of strings Назва та колір тегу контакту. Колір за замовчуванням - #c377e0.
customData Array

Ваші власні дані, представлені у вигляді масиву. Кожен атрибут складається з назви (обов’язкова) і значення (обов’язкове).

Чи була наша стаття корисною?