База знаний CleverApp ⤵
Контакты
GET Получить список контактов
https://app.cleverapp.pro/api/v2/getContacts
Получение количества контактов: https://app.cleverapp.pro/api/v2/getNumberOfContacts
!Как правильно сформировать запрос?! Смотрим в основах Этот метод позволяет получить список контактов указанного бота.
Path Parameters
date_from
OPTIONAL
integerФильтр по дате создания контакта в формате Unix Time
date_to
OPTIONAL
integerФильтр по дате создания контакта в формате Unix Time
count
OPTIONAL
integerКоличество контактов для получения. Максимальное значение: 500
with
OPTIONAL
stringСписок дополнительных сущностей для контакта, передается в виде перечисления через запятую. Пример: tags,variables
bot_id
OPTIONAL
integerID бота.
200: OK
Запрос успешно обработан.
1 {
2 "data": [
3 {
4 "id": 1,
5 "bot_id": 1,
6 "phone": "79991234567",
7 "email": "info@example.com",
8 "name": "Иван Иванов",
9 "messenger": "whatsapp",
10 "address": "г. Москва, ул. Пушкина, д. 5",
11 "utm": {
12 "utm_source": "landing",
13 "utm_medium": "...",
14 "utm_campaign": "...",
15 "utm_term": "...",
16 "utm_content": "..."
17 },
18 "created_at": "2019-05-10T10:38:28+00:00"
19 },
20 {
21 "id": 2,
22 "bot_id": 1,
23 "phone": "792712312321",
24 "email": null,
25 "name": "Петр Петров",
26 "messenger": "telegram",
27 "telegram_id": "123456",
28 "telegram_username": "superman",
29 "address": null,
30 "utm": null,
31 "created_at": "2019-04-02T12:16:16+00:00"
32 },
33 {
34 "id": 3,
35 "bot_id": 2,
36 "phone": null,
37 "email": null,
38 "name": "Василий Васильев",
39 "messenger": "viber",
40 "viber_id": "1123456789dD20=",
41 "address": null,
42 "utm": null,
43 "created_at": "2019-05-11T15:31:34+00:00"
44 },
45 ],
46 "links": {
47 "first": "http:\/\/app.cleverapp.ru\/api\/v1\/getContacts?page=1",
48 "last": "http:\/\/app.cleverapp.ru\/api\/v1\/getContacts?page=1",
49 "prev": null,
50 "next": null
51 },
52 "meta": {
53 "current_page": 1,
54 "from": 1,
55 "last_page": 1,
56 "path": "http:\/\/app.cleverapp.ru\/api\/v1\/getContacts",
57 "per_page": 500,
58 "to": 3,
59 "total": 3
60 }
61 }Список дополнительных сущностей для контакта:
- tags– список тегов
- variables– список пользовательских переменных.