create_label() | add_label() | remove_label() | remove_label_everywhere() | count_of_clients_with_label() | has_label()
Описание
Метки Salebot отображаются как в карточке клиента:
так и в разделе "Списки":
- create_label(label_name) - создание метки Salebot с указанным именем.
Параметры:
! label_name- имя метки, задается в одинарных кавычках ''
- add_label(label_name, client_id) - добавление метки Salebot клиенту.
Параметры:
! label_name - имя метки, задается в одинарных кавычках ''
client_id - идентификатор клиента. Если не передан, то используется идентификатор текущего клиента
- remove_label(label_name, client_id) - удаление метки у клиента
Параметры:
! label_name - имя метки, задается в одинарных кавычках ''
client_id - идентификатор клиента. Если не передан, то используется идентификатор текущего клиента
- has_label(label_name, client_id) - проверить наличие метки у клиента
Параметры:
! label_name - имя метки, задается в одинарных кавычках ''
client_id - идентификатор клиента. Если не передан, то используется идентификатор текущего клиента
- remove_label_everywhere(label_name) - удаление метки у всех клиентов
Параметры:
! label_name- имя метки, задается в одинарных кавычках ''
- count_of_clients_with_label(label_name) - получение общего количества клиентов с меткой
Параметры:
! label_name- имя метки, задается в одинарных кавычках ''
Пример
Итак, разберем как же создается метка Salebot.
Достаточно единожды выполнить функцию создания в сером блоке (блоке не состояние), например:
При этом в переменной a можно проанализировать успех выполнения функции создания метки:
Далее метку можно назначить любому из клиентов, для этого пропишите функцию add_label() в нужном блоке Вашей воронки:
Проверить наличие метки у клиента можно при помощи функции has_label():
Функция возвращает логическое значение True или False 
Аналогичным методом выполняются и другие действия над метками - удаление метки у конкретного клиента, удаление метки в целом у всех клиентов.
Можно посчитать количество клиентов с заданной меткой - воспользуйтесь функцией count_of_clients_with_label()
Пример кода для копирования
/*Создание метки*/
a=create_label('метка1')
/*Прописать метку клиенту*/
a=add_label('этап 1')
/*Проверить есть ли метка у клиента*/
a=has_label('этап 1','73704021')
/*Подсчет количества клиентов по заданной метке*/
etap1=count_of_clients_with_label('этап 1')
tovar1=count_of_clients_with_label('1')
Создание метки из блока
create_label()
Описание
create_label(label_name) - создание метки Salebot с указанным именем.
Параметры:
! label_name- имя метки, задается в одинарных кавычках ''
Создание метки из блока без создания дубля
create_label_if_not_exist()
Описание
create_label_if_not_exist(name, color) - создает новую метку, если с таким именем еще нет и возвращает идентификатор или вернет идентификатор существующей
name — название метки
color — цвет метки (по умолчанию 0)
Таблица цветов для параметра color:
0 — светло-серый
1 — желтый
2 — синий
3 — красный
4 — розовый
5 — бежевый
6 — фиолетовый
7 — голубой
8 — серый
9 - зеленый
Получить все метки клиента
get_all_client_labels()
Параметры функции
get_all_client_labels(client_id)
Параметры:
client_id - не обязателен, если не передан, будут получены метки текущего клиента.
Функция возвращает ответ в формате json: {"161":"metka1","228":"metka2"}, где:
ключ - это id метки, значение - ее название.
Пример
Удалить метки клиента массивом
remove_multiple_client_labels()
Параметры функции
remove_multiple_client_labels(labels_array, names) - функция удалит те метки, что указаны в массиве.
labels_array - массив меток. ИЛИ массив идентификаторов, ИЛИ массив названий.
Если передается массив НАЗВАНИЙ, то дополнительно ❗Обязательно передать второй параметр(names) равный 1.
names - Указать 1, если список названий меток, а не идентификаторы. Это указание на то, что список имен.
НЕЛЬЗЯ в одной функции объединять и идентификаторы и названия меток!!!!
Пример
/*Удалить метки по идентификатору*/
r = remove_multiple_client_labels('[138,169,166]')
/*Удалить метки по названию метки*/
r2 = remove_multiple_client_labels('["newTestTag","metka2"]', 1)
В переменную запишется результат выполнения функции: или вернет текст ошибки, или число, сколько было удалено меток.
Найти клиентов по нескольким меткам
find_clients_by_multiple_labels()
Параметры функции
find_clients_by_multiple_labels(labels_array, names) - Найти клиентов по нескольким меткам
ВАЖНО! Найдет только тех клиентов, у которых есть ВСЕ переданные метки.
Параметры:
labels_array - массив меток. ИЛИ массив идентификаторов, ИЛИ массив названий.
Если передается массив НАЗВАНИЙ, то дополнительно ❗Обязательно передать второй параметр(names) равный 1.
names - Указать 1, если список названий меток, а не идентификаторы. Это указание на то, что список имен.
НЕЛЬЗЯ в одной функции объединять и идентификаторы и названия меток!!!!
Вернет список идентификаторов клиентов (client_id): [41121, 41192, 41522]
Пример
/* Найти клиентов у кого есть все указанные метки, по идентификатору*/
r = find_clients_by_multiple_labels('[138,169,166]')
/*Найти клиентов у кого есть все указанные метки, по названию меток*/
r2 = find_clients_by_multiple_labels('["newTestTag","metka2"]', 1)
Проверка наличия списка меток у клиента
has_client_multiple_labels()
Параметры функции
has_client_multiple_labels(labels_array, names) - Проверка наличия списка меток у клиента.
ВАЖНО вернет True, если у клиента есть все переданные метки!
labels_array - массив меток. ИЛИ массив идентификаторов, ИЛИ массив названий.
Если передается массив НАЗВАНИЙ, то дополнительно ❗Обязательно передать второй параметр(names) равный 1.
names - Указать 1, если список названий меток, а не идентификаторы. Это указание на то, что список имен.
НЕЛЬЗЯ в одной функции объединять и идентификаторы и названия меток!!!!
Возвращает либо ошибку, либо True - есть все метки из массива, или False, если не все метки есть у клиента
Пример
/*Проверить наличие у клиента всех указанных меткок, по идентификатору*/
r = has_client_multiple_labels('[138,169,166]')
/*Проверить наличие у клиента всех указанных меток, по названию меток*/
r2 = has_client_multiple_labels('["newTestTag","metka2"]', 1)
Получить массив ID всех меток клиента
get_all_client_label_ids(client_id)
Описание
get_all_client_label_ids(client_id) — возвращает массив с ID всех меток, присвоенных клиенту.
Если у клиента нет меток — возвращает пустой массив [].
Параметры:
client_id — идентификатор клиента Salebot. Если не передан, используется идентификатор текущего клиента.