Кожна розмова й кожен дзвінок належать клієнту — тій самій людині в усіх ваших каналах. Клієнтів об’єднують лише за даними, які неможливо підробити, як-от номер, з якого телефонують, або ID, який ваш сайт підписує для відвідувача, що увійшов; email чи телефон, який людина вводить сама, зберігається в профілі, а об’єднує клієнтів ваша команда в панелі. Ваші системи можуть читати базу клієнтів, підтримувати її актуальною й додавати те, що відбувається поза EvaSay.
| Метод | Шлях | Що робить |
|---|---|---|
| GET | /api/v1/voice/contacts | Клієнти, спершу нещодавні: q шукає в іменах, email, телефонах, компаніях і тегах, segment_id залишає клієнтів однієї групи, limit (до 100) і offset гортають |
| GET | /api/v1/voice/contacts/{id} | Один клієнт із даними, тегами, згодами й вашими власними полями |
| PATCH | /api/v1/voice/contacts/{id} | Змінити name, email, phone, company, city, country, language, timezone, tags або attributes |
| GET | /api/v1/voice/contact-fields | Ваші власні поля клієнтів: для кожного key, label, type і options |
| GET | /api/v1/voice/contacts/{id}/events | Стрічка подій клієнта, спершу нові |
| POST | /api/v1/voice/contacts/{id}/events | Додати подію зі своїх систем |
| GET | /api/v1/voice/contacts/{id}/consent | Кожна зміна згоди, з джерелом і підтвердженням |
| POST | /api/v1/voice/contacts/{id}/consent | Записати зміну згоди |
| GET | /api/v1/voice/segments | Групи клієнтів; counts=true додає, скільки клієнтів у кожній зараз |
curl https://evasay.com/api/v1/voice/contacts/CONTACT_ID \
-X PATCH \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "company": "Acme Dental", "tags": ["vip"], "attributes": { "plan": "Gold" } }'
tags замінює всі теги клієнта. attributes приймає ключі ваших власних полів (додайте їх на сторінці Клієнти; їх перелічує GET /api/v1/voice/contact-fields) зі значенням типу поля; порожній рядок очищає значення. Значення, яке ваша команда ввела в панелі, зберігається: API його не перезаписує, і агент теж. Зміна email чи телефону не об’єднує клієнта з іншим, у якого вони такі самі. Стандартні дані (name, email, phone та інші) замінюються тим, що ви надіслали.
Надсилайте те, що відбувається у ваших системах, — покупку, візит чи продовження, — щоб це з’явилося в стрічці клієнта:
curl https://evasay.com/api/v1/voice/contacts/CONTACT_ID/events \
-X POST \
-H "Authorization: Bearer sk-your-key" \
-H "Content-Type: application/json" \
-d '{ "event_id": "order-1042", "name": "order_paid", "subject": "Order 1042", "values": { "total": "89.00" } }'
name складається з малих літер, цифр, _ і .. event_id — ваш власний ID: той самий event_id в одного клієнта записується один раз, тож повторювати запит безпечно, а для повтору accepted дорівнює false. values містить текст, flags — true або false, а appointment_at — час у мілісекундах Unix.
EvaSay веде чотири види згод окремо: marketing_email, marketing_sms, marketing_calls і service_calls (обидва види дзвінків охоплюють дзвінки голосом ШІ). Кожна має стан granted, withdrawn або, доки записів немає, unknown. Зміну ніколи не редагують, а лише додають до історії з джерелом і підтвердженням:
{ "kind": "marketing_calls", "status": "granted", "note": "Ticked 'Call me about offers' on order 1042" }
Записувати згоди можуть лише ключі власників і адміністраторів, а note — ваше підтвердження — обов’язковий.
Групи — це збережені фільтри бази клієнтів: ті, що є в кожному робочому просторі (усі клієнти, VIP, нові за останні 7 днів та інші), групи вашої галузі й ті, що ви створюєте на сторінці Клієнти. GET /api/v1/voice/segments перелічує їх з id; передайте його як segment_id, щоб отримати клієнтів групи.
Ваші системи також можуть одразу дізнаватися про зміни: contact.created, contact.updated, contact.consent_changed і contact.merged — це події вебхуків.