API конструктора
*Facebook, Instagram, WhatsApp принадлежат Meta, деятельность которой признана в РФ экстремистской и запрещена.
Некоторые Функции API-запросов можно выполнять в Калькуляторе.
Запросы выполняются методом POST/GET на URL, типа: https://chatter.salebot.pro/api/{api_key}/{action}
Где: api_key ключ доступа к API, который генерируется в настройках проекта:
Чтобы использовать токен в URL запросе необходимо сгенерировать апи-ключ.
Как это сделать, рассказали в разделе "Генерация api key"
При копировании url запроса с этой страницы подставляется пробел, который необходимо при вызове удалить.
Пример неправильно скопированной ссылки: https://chatter.salebot.pro /api/callback
Пробел после .pro не так просто заметить. С ним запрос не будет выполняться
При отправке запроса методом GET не используйте запрещенные символы. Изучите правильное формирование GET запросов.
Как сгенерировать api key
Старый функционал генерации api работает в прежнем режиме, но не доступен для новых проектов.
Если в вашем проекте существуют ключи api, сгенерированные без настроек доступа, описанных в данном разделе, то старые api_key будет работать в штатном режиме.
Если вам понадобится генерация новых ключей, то воспользуйтесь новыми настройками.
Для генерации ключа api перейдите в настройки проекта:
Далее перейдите в раздел "Интеграции":
В разделе "Интеграции" вы найдете кнопку "Добавить API ключ":
После нажатия на кнопку откроется модальное окно с настройками доступа и генерацией апи ключа:
Далее необходимо выбрать права доступа для ключа api:
В зависимости от выбранного права доступа, будет работать функция api.
Обращаем внимание!
От выбранных прав доступа зависит работа функции api: если вы сгенерируете api ключ, у которого права только для чтения информации о клиентах, и примените такой ключ в запросе на отправку сообщения клиенту или изменение его переменных, то api-запрос не сработает.
Какое разрешение необходимо для каждого api запроса указано в карточке апи-запроса:
Далее пропишите название для api ключа:
Далее сгенерируйте ключ апи, кликнув по кнопке "Сгенерировать":
После чего нажмите "Готово" и ключ api добавится в раздел:
Вы можете добавить любое необходимое количество ключей api, назначив различные права доступа.
Далее вам необходимо назначить основной ключ проекта - это необходимо для того, чтобы доступ к апи ключу можно было получить через конструкцию #{api_key} в URL запроса.
Для этого нажмите на кнопку "{+}" справа от строки нужного апи-ключа:
Далее возле ключа появится пометка, что он является основным ключом проекта:
Доступ к основному ключу проекта вы можете получить через api_key: то есть вам достаточно сгенерировать необходимый ключ, выставить разрешения и назначить его основным ключом проекта. Далее в api-запросе в калькуляторе передать URL запроса с конструкцией #{api_key}, в котором будет лежать значение основного ключа проекта.
Остальные сгенерированные ключи с настройками доступа будут являться дополнительными. В URL запроса достаточно передать их значение вместо #{api_key}. Для этого необходимо скопировать значение дополнительного ключа:
И вставить в URL запроса вместо #{api_key}:
Ранее сгенерированный api-ключ (по-старому типу) является основным ключом проекта по умолчанию и имеет все разрешения.
Внимание!
Если вы удалите ключ, назначенный основным ключом проекта, то вам необходимо будет назначить новый ключ как основной вручную.
Напоминаем!
Если у вас есть сгенерированные апи-ключи старого типа, то они будут работать в обычном режиме. Снова сгенерировать апи-ключи старого типа нельзя.
Как получать сообщения на Webhook URL, указанный в настройках проекта
Каждое входящее или исходящее сообщение будет приходить следующим json POST запросом:
Если запрос вернул ошибку, повторной отправки не будет. Если сервер возвращает ошибки, уведомления продолжат отправляться несмотря на это.
Как написать json-запрос
Переходим в настройки блока, в котором у нас будет осуществляться запись данных таблицу.
Добавляем раздел API-запрос.
Выбираем тип запроса POST-json
Переходим к заполнению полей запроса:
URL запроса - путь к функции для выполнения запроса. Далее в документации всегда в первой строке, рядом с типом запроса:
Сохраняемые значения - перечень параметров ответа запроса с указанием имен переменных, в которые следует сохранить результат в формате:
параметр_из_запроса -> ваша_переменная
Если в ответ получаем параметры сложной структуры, то разбираем их так:
"cell_number":{"row":4,"col":2} cell_number|row -> Строка; cell_number|col -> Столбец
Заголовок запроса - заполняется при необходимости. Чаще всего здесь передаются форматы передаваемых данных и/или токен доступа
JSON-параметры - тело запроса, в котором прописываются параметры передаваемых данных в формате(ниже возможный вариант написания):
{"client_id": "#{id_получателя_в_конструкторе}", "message":"Hello!"}
Для понимания в какой структуре запрос возвращает ответ, напишите в поле Сообщение вывод значения переменной #{custom_answer}.
Далее в документации допустимые параметры указаны в Body:
Как использовать универсальный webhook
Перечисленные методы теперь могут быть запущены как POST, так и GET запросом.
Раньше в наших методах были жестко прописаны параметры, по которым запускались выполнения методов для подписчиков (например client_id и vk_id) и это накладывало некоторые ограничения для использования их со сторонними сервисами.
Теперь вы можете указать, в каком параметре запроса сэйлбот будет искать идентификатор пользователя: для этого используется параметр с префиксом value_, например value_user_id и value_group_id.
А еще метод отправки колбека callback, теперь можно запустить передав электронный адрес (client_email) или телефон (client_phone) клиента.
Методы callback, vk_callback, ok_callback и whatsapp_callback не привязаны к именам параметра. Вы можете указать, в каком параметре будет находиться номер телефона, email или id-клиента.
Это удобно, когда вы настраиваете прием вебхука с какого-то сайта.
Чтобы указать, в какой переменной лежит client_id, необходимо передать параметр value_client_id, в котором указать название параметра с этим значением.
Чтобы указать, в какой переменной лежит phone, необходимо передать параметр value_phone, в котором указать название параметра с этим значением.
Чтобы указать, в какой переменной лежит email, необходимо передать параметр value_email, в котором указать название параметра с этим значением.
Чтобы указать, в какой переменной лежит user_id, необходимо передать параметр value_user_id, в котором указать название параметра с этим значением.
Чтобы указать, в какой переменной лежит group_id, необходимо передать параметр value_group_id, в котором указать название параметра с этим значением.
Чтобы указать переменную, в которой находится само сообщение в вебхуке, необходимо передать value_message (передается по аналогии с другими параметрами (phone, email и т.д.))
Пример:
В адрес пропишем value_client_id = my_client
https://chatter.salebot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}
Запрос будет эквивалентен запросу ниже:
https://chatter.salebot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Как можно заметить, название параметра, в котором лежит имя, отличается припиской value_
Обращаем внимание!
Некоторые события генерируют системное уведомление в проекте.
Например, существуют системные уведомления с message, которые приходят не пустыми, но без текста от клиента.
При этом в проекте также могут генерироваться хуки message с определенным содержанием следующего вида: "message: new_chat_member"
Соответственно, следует обращать внимание на содержание: это либо системное уведомление, либо хук с определенным событием.
Как запускать бота
Запуск бота
POST https://chatter.salebot.pro/api/#{api_key}/callback
URL запроса: https://chatter.salebot.pro/api/#{api_key}/callback Метод можно использовать для запуска воронки у клиента или подтверждения действия на стороннем ресурсе. Данное сообщение не увидит клиент. Дополнительно переданные параметры сохранятся в переменные. Метод отправки колбека, теперь можно запустить передав электронный адрес (client_email) или телефон (client_phone) клиента.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
client_phone - телефон, по которому будет искаться клиент
client_email - email, по которому будет искаться клиент
client_id - id клиента в конструкторе
message - Текст сообщения
resume_bot - True (необязательный параметр). Если бот на паузе, чтобы снять с паузы.
Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Запуск бота по идентификатору пользователя ВКонтакте
POST https://chatter.salebot.pro/api/#{api_key}/vk_callback
URL запроса: https://chatter.salebot.pro/api/#{api_key}/vk_callback
Метод можно использовать для запуска воронки у клиента или подтверждения действия на стороннем ресурсе. Данное сообщение не увидит клиент. Дополнительно переданные параметры сохранятся в переменные.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
message - Текст сообщения user_id - id пользователя вконтакте group_id - id группы вконтакте resume_bot - True (необязательный параметр). Если бот на паузе, чтобы снять с паузы. Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Запуск бота по номеру WhatsApp*
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_callback *
URL запроса: https://chatter.salebot.pro/api/<api_key>/whatsapp_callback *
Этот метод может запустить вотсап бота, после регистрации клиента на сайте или после того, как он оставит заявку с номером телефона. Дополнительно переданные параметры сохранятся в переменные.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
name - Имя клиента message - Текст сообщения phone - Номер телефона клиента bot_id - Идентификатор бота resume_bot - True (необязательный параметр). Если бот на паузе, чтобы снять с паузы. Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Запуск бота по идентификатору пользователя Одноклассников
POST https://chatter.salebot.pro/api/#{api_key}/ok_callback
URL запроса: https://chatter.salebot.pro/api/#{api_key}/ok_callback
Метод можно использовать для запуска воронки у клиента или подтверждения действия на стороннем ресурсе. Данное сообщение не увидит клиент. Дополнительно переданные параметры сохранятся в переменные.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
name - Имя клиента message - Текст сообщения user_id - Идентификатор бота group_id - ID группы Одноклассников resume_bot - True (необязательный параметр). Если бот на паузе, чтобы снять с паузы. Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Запуск бота по идентификатору Telegram
POST https://chatter.salebot.pro/api/#{api_key}/tg_callback
URL запроса: https://chatter.salebot.pro/api/#{api_key}/tg_callback
Метод можно использовать для запуска воронки у клиента или подтверждения действия на стороннем сайте. Данное сообщение не увидит клиент. Дополнительно переданные параметры сохраняются в переменные.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
message - Текст сообщения user_id - Идентификатор пользователя в Телеграм group_id - название бота (заканчивается на bot) resume_bot - True (необязательный параметр). Если бот на паузе, чтобы снять с паузы. Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Отправка Callback-сообщений списку клиентов по platform_id
POST https://chatter.salebot.pro/api/#{api_key}/send_callback_by_platform_id
URL запроса: https://chatter.salebot.pro/api/#{api_key}/send_callback_by_platform_id
При обнаружении в проекте клиентов с platform_id из списка отправит callback с текстом из поля callback_text. Ограничение: 1 запрос = не более 300 отправлений
Пример параметров запроса: {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
platform_ids - список идентификаторов клиентов в мессенджере callback_text - текст callback group_id - идентификатор бота
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Отправка callback-сообщения email-клиенту
POST https://chatter.Salebot.pro/api/#{api_key}/email_callback
URL запроса: https://chatter.Salebot.pro/api/#{api_key}/email_callback
Этот метод может запустить email-бот после регистрации клиента на сайте или после того, как он оставит заявку с email, при этом метод находит email-клиента или создает его, если тот не найден.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Дополнительно переданные параметры сохранятся в переменные
Path
api key* - токен доступа
Body
name - имя клиента message - текст сообщения email - адрес почты email_id_bot - email-адрес бота resume_bot - True (необязательный параметр).
Если бот на паузе, чтобы снять с паузы.
Пример: resume_bot = True
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Как работать с сообщениями
Параметры отправки сообщения
attachment_type может принимать значения: image, video, link, file, audio При отправке вложения параметр message необязателен buttons - определяет кнопки, которые будут прикреплены к сообщению. Формат кнопок аналогичен расширенным настройкам кнопок. Возможны два варианта передачи кнопок: с указанием подсказки для мессенджеров без кнопок и без нее.
Пример параметра buttons:
Отправка сообщения клиенту
POST https://chatter.salebot.pro/api/#{api_key}/message
URL запроса: https://chatter.salebot.pro/api/#{api_key}/message
Этот метод можно использовать для отправки сообщений с уведомлениями. Параметр message обязателен, если вы не отправляете файл. Если вы отправляете файл, текст необязателен.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
message_id - Номер блока для отправки message - Текст сообщения client_id - id клиента в конструкторе attachment_type - Тип отображения файла. Обязательный, если передан attacment_url attachment_url - url файла buttons - Кнопки
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Отправка сообщения в Whatsapp
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message
URL запроса: https://chatter.salebot.pro/api/<api_key>/whatsapp_message
Позволяет отправить сообщение от имени подключенного бота на указанный номер whatsapp_bot_id необходимо взять из раздела мессенджеры и чаты. Каждому подключенному вотсапу конструктор присваивает уникальный идентификатор.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
message_id - Номер блока для отправки whatsapp_bot_id - Идентификатор вотсап бота, от которого нужно отправить сообщение attachment_url - url файла attachment_type - Тип отображения файла. Обязательный, если передан attacment_url message - Текст сообщения phone - Номер телефона получателя
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Массовая отправка сообщений
POST https://chatter.salebot.pro/api/#{api_key}/broadcast
URL запроса: https://chatter.salebot.pro/api/#{api_key}/broadcast
Метод позволяет запустить рассылку.
Можно использовать один из вариантов, они взаимоисключающие:
передан параметр list - рассылка будет произведена по указанному списку клиентов Метод позволяет запустить рассылку.
передан параметр clients - рассылка будет произведена по массиву переданных идентификаторов клиентов
передан параметр platform_ids и group_id - рассылка будет произведена по массиву переданных platform_id (идентификатор в мессенджере) указанного бота (group_id)
Если не передан ни один из выше перечисленных, рассылка не будет отправлена.
Обязательный параметр message (и\или attachment_type и attachment_url) ИЛИ message_id
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
list - Номер списка, по которому необходимо разослать
clients - Идентификаторы получателей в конструкторе
message - Текст сообщения
platform_ids - Идентификаторы получателей в мессенджере. Вместе с ним передать обязательный параметр group_id
group_id - Обязательный, работает только с platform_ids. При работе с другими вариантами - игнорируется. Для отправки по platform_ids указанного бота.
attachment_url - url файла
attachment_type - Тип отображения файла. Обязательный, если передан attacment_url
buttons - кнопки
message_id - Номер блока для отправки
shift - Количество секунд между сообщениями. По умолчанию 0.2
time_shift - число. Если указать, сообщение будет отправлено через указанное количество секунд от текущего времени.
send_time - дата и время в формате "%Y-%m-%d %H:%M:%S" ("2024-10-16 13:15:59"). Позволяет указать дату и время для отправки сообщения. Если указать time_shift и send_time одновременно, будет использован time_shift
Получение истории сообщений
GET https://chatter.salebot.pro/api/#{api_key}/get_history?client_id=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_history?client_id=
Параметр client_id можно получить ТУТ
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
client_id - id клиента
limit - Количество элементов в ответе/ По умолчанию 2000, максимальное значение 2000
start_date - указание даты, начало периода выборки (поле обязательное, если указывается stop_date), формат: дд.мм.гггг
stop_date - указание даты, конец периода выборки (поле обязательное, если указывается start_date), формат: дд.мм.гггг
Очистить историю сообщений
GET https://chatter.salebot.pro/api/#{api_key}/clear_history?client_id=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/clear_history?client_id=
Удаляет историю переписки
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
client_id - id клиента
Для работы с клиентами
Определение клиента сотруднику
POST https://chatter.salebot.pro/api/#{api_key}/assign_to_user
URL запроса: https://chatter.salebot.pro/api/#{api_key}/assign_to_user
Метод позволяет определить клиента сотруднику. Параметр e-mail не обязателен. Если емейл не передать, распределит по алгоритму системы.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
client_id - id клиента email - е-мейл сотрудника (опционально)
Загрузка клиентов в систему
POST https://chatter.salebot.pro/api/#{api_key}/load_clients
URL запроса: https://chatter.salebot.pro/api/#{api_key}/load_clients
Метод позволяет загрузить клиентов в систему. При загрузке клиентов whatsapp можно передавать номер в свободном формате, как с концовкой @s.whatsapp.net, так и без нее.
Идентификатор группы (group_id) можно получить ТУТ через /api/<api_key>/connected_channels
(если client_type=13 (телефония), то group_id="")
Тип мессенджера, откуда пришел клиент (client_type) можно посмотреть ТУТ
Пример: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
platform_id - номер телефона group_id - id группы client_type - тип мессенджера, откуда пришел клиент
Добавить клиентов в список
POST https://chatter.salebot.pro/api/<api_key>/add_to_list
URL запроса: https://chatter.salebot.pro/api/<api_key>/add_to_list
Добавляет клиентов в список
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
list_id - Номер списка clients - массив id клиентов
Пример: JSON параметры {"list_id":1170282, "clients":[411262772, 646410963]}
Удалить клиентов из списка
POST https://chatter.salebot.pro/api/#{api_key}/remove_from_list
URL запроса: https://chatter.salebot.pro/api/#{api_key}/remove_from_list
Удаляет клиентов из списка
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
list_id - Номер списка clients - массив с номерами клиентов в конструкторе Salebot (значения client_id)
Получение списка клиентов
GET https://chatter.salebot.pro/api/<api_key>/get_clients
URL запроса: https://chatter.salebot.pro/api/<api_key>/get_clients
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
offset - Смещение относительно первого элемента limit - Количество элементов в ответе/ По умолчанию 500, максимальное значение 500. list - номер списка reverse - указание обратной сортировки(от самой "старой" записи к самой "новой"). Параметр работает при отсутствии параметра list
Возвращает статус и массив элемента
Разрешение на удаление клиентов
POST https://chatter.salebot.pro/api/#{api_key}/delete_clients
URL запроса: https://chatter.salebot.pro/api/#{api_key}/delete_clients
Разрешение доступа при генерации ключа: "Разрешение на удаление клиентов":
Path
api key* - токен доступа
Body
client_ids - список идентификаторов клиентов, которых нужно удалить. Максимум 500. Пример: [199571, 199707, 1935722]
Как работать с переменными
Присвоение переменных
POST https://chatter.salebot.pro/api/#{api_key}/save_variables
URL запроса: https://chatter.salebot.pro/api/#{api_key}/save_variables
! Лимита по данному запросу нет.
Позволяет сохранить переменные в заявку и в клиента. Запрос присвоения переменных по умолчанию добавляет в переменные сделок. И если нужно изменить переменные в профиле, нужно прописывать префикс client. Например, для телефона: client.phone
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Update: Параметр clients позволяет массово присваивать переменные.
Пример: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}
Path
api key* - токен доступа
Body
clients - Массив id клиентов для присвоения переменных client_id - id клиента variables - Хеш переменных(ключ-значение)
Получение переменных
GET https://chatter.salebot.pro/api/#{api_key}/get_variables?client_id=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_variables?client_id=
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Пример: https://chatter.salebot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/get_variables?client_id=49177759
Path
api key* - токен доступа
Body
client_id - id клиента
Как получить id клиента (client_id)
Получение client_id по значению platform_id
POST https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_platform_id
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_platform_id
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
platform_ids - массив идентификаторов в мессенджере group_id - идентификатор бота
Получить id клиента из Онлайн-чата
GET https://chatter.salebot.pro/api/#{api_key}/online_chat_client_id?recipient=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/online_chat_client_id?recipient=
Этот метод позволяет интегрировать сайт и чат-бота. Например, если человек зашел на страницу с акцией, прислать сразу же сообщение в чат о персональном предложении.
Разрешение доступа при генерации ключа "Разрешение на изменение/удаление информации о клиентах":
Path
api key* - токен доступа
Body
tag - Тег (метка клиента) name - Имя клиента recipient - Идентификатор диалога на сайте
Где взять recipient?
На сайте, где размещен онлайн чат "Salebot.pro" при помощи JS получите свойство SaleBotPro.recipient_id
Получение client_id по номеру Whatsapp*
GET* https://chatter.salebot.pro/api/#{api_key}/whatsapp_client_id?phone=
URL запроса*: https://chatter.salebot.pro/api/#{api_key}/whatsapp_client_id?phone=
Метод вернет идентификатор клиента для выполнения запросов к API, если вы знаете номер телефона клиента в Whatsapp* Если клиента нет с таким номером, то метод вернет 404
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
phone - Номер телефона group_id - Идентификатор бота
Получение client_id по номеру телефона
GET https://chatter.salebot.pro/api/<api_key>/find_client_id_by_phone?phone=
URL запроса: https://chatter.salebot.pro/api/<api_key>/find_client_id_by_phone?phone=
Метод вернет идентификатор клиента для выполнения запросов к API. Поиск происходит как по клиентам whatsapp, так и по переменным
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
phone - Номер телефона
Получение client_id по email
GET https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_email?email=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_email?email=
Метод вернет идентификатор клиента для выполнения запросов к API. Поиск происходит по переменным.
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
email - Email для поиска
Получение client_id по значению переменной
GET https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_var?var=&val=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_client_id_by_var?var=&val=
Метод вернет идентификатор клиента для выполнения запросов к API
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
var - Имя переменной, по которой будет поиск val - Значение переменной group_id - Идентификатор группы search_in - Передать значение 'order' для поиска по переменным сделки; Ищет до 3-х переменных у клиентов проекта, возвращает список клиентов, у которых есть все заявленные переменные.
Получение id последнего созданного клиента по значению переменной
GET https://chatter.salebot.pro/api/#{api_key}/find_latest_client_id_by_var?var=&val=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_latest_client_id_by_var ?var=&val=
Метод вернет id последнего созданного клиента для выполнения запросов к API. Ищет по переменным клиента и сделок.
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
var - Имя переменной, по которой будет поиск val - Значение переменной
Получение списка client_id по значению переменной
GET https://chatter.salebot.pro/api/#{api_key}/find_all_client_id_by_var?var=&val=
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_all_client_id_by_var?var=&val=
Метод вернет список идентификаторов клиентов, у которых есть заданная переменная с заданным значением
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
var - Имя переменной, по которой будет поиск val - Значение переменной
Получение списка client_id по значениям нескольких переменных
GET https://chatter.salebot.pro/api/#{api_key}/find_all_client_id_by_several_vars?var=val
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Body
variable1 - Значение1
variable2 - Значение2
variable3 - Значение3
Поиск по переменным
POST https://chatter.salebot.pro/api/#{api_key}/find_clients
URL запроса: https://chatter.salebot.pro/api/#{api_key}/find_clients
Метод осуществляет поиск по переменным, вернет список идентификаторов клиентов, удовлетворяющих условию запроса.
Примеры параметров: по умолчанию поиск производится по переменным клиента (рекомендуется)
{"q": {"result": "ok", "var": "дом", "var": "60"}} - поиск по переменным клиента, у клиента должны быть все указанные переменные
{"q": {"result": "ok", "var": "дом", "var": "60"}, "search_in": "order", "include_all": False} - поиск по переменным сделок ("search_in": "order"), в сделке должны быть хотя бы одна из указанных переменных ("include_all": False)
{"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}} - переменная клиента name равна одному из значений списка ["Joe", "Jane", "Donald"]
{"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}} - переменная клиента name НЕ равна одному из значений списка ["Joe", "Jane", "Donald"]
{"q": {"name": {"_not": "Joe"}}} - переменная клиента name не равна Joe
Внимание!
Сравнение чисел возможно только, если у всех клиентов в искомой переменной число. Если хотя бы у одного будет строка, запрос не отработает.
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Параметры
Path
api key* - токен доступа
Body
q - обязательный параметр, query условия на поиск переменных
search_in - по переменным какой сущности искать, если не передать ищет по переменным клиента, может принимать значение order
include_all - обязательное выполнение всех условий из параметра q, False - если одно из условий совпало, отбирает сущность
Как работать со сделками
Получение идентификатора текущей сделки
GET https://chatter.salebot.pro/api/#{api_key}/get_current_order_id
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_current_order_id
Разрешение доступа при генерации ключа: "Разрешение на чтение информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
Получение списка сделок
GET https://chatter.salebot.pro/api/#{api_key}/get_orders
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_orders
Разрешение доступа при генерации ключа: "Разрешение на чтение информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
order_status - Статус сделки: 0 - активные сделки 1 - успешные сделки 2 - проваленные сделки
Перемещение сделки на следующее по порядку состояние воронки Salebot
POST https://chatter.salebot.pro/api/#{api_key}/move_order_to_next_state
URL запроса: https://chatter.salebot.pro/api/#{api_key}/move_order_to_next_state
Разрешение доступа при генерации ключа: "Разрешение на изменение/удаление информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
order_id - Идентификатор сделки
Получение данных сделки
POST https://chatter.salebot.pro/api/#{api_key}/get_order_vars
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_order_vars
Разрешение доступа при генерации ключа: "Разрешение на чтение информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
order_id - Идентификатор сделки
variables - массив переменных (формат:["var_name1", "var_name2"])
Добавление переменных сделки
POST https://chatter.salebot.pro/api/#{api_key}/set_order_vars
URL запроса: https://chatter.salebot.pro/api/#{api_key}/set_order_vars
Разрешение доступа при генерации ключа: "Разрешение на изменение/удаление информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
order_id - Идентификатор сделки
variables - словарь переменных (Ключ это название переменной, а значение это то, что нужно сохранить в эту переменную) (формат:{"var_name": "var_velue"})
Создание сделки
POST https://chatter.salebot.pro/api/#{api_key}/create_order
URL запроса: https://chatter.salebot.pro/api/#{api_key}/create_order
Разрешение доступа при генерации ключа: "Разрешение на изменение/удаление информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
name - название сделки
description - описание сделки
budget - стоимость сделки
state_id - id состояния, в которое нужно поместить сделку
При запросе необходимо указать один из следующих параметров: client_id, email, phone. Если указать несколько из этих параметров, использоваться будет только один. Приоритет использования в порядке убывания: client_id > phone > email.
Если указан phone или email, и клиента с таким телефоном или почтой нет, будет создан новый клиент.
Перенос сделки в состояние SalebotCRM
POST https://chatter.salebot.pro/api/#{api_key}/set_order_state
URL запроса: https://chatter.salebot.pro/api/#{api_key}/set_order_state
Разрешение доступа при генерации ключа: "Разрешение на изменение/удаление информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
state_id - Номер состояния, в которое нужно перенести сделку клиента
Получения id состояния воронки в SalebotСRM
GET https://chatter.salebot.pro/api/#{api_key}/get_order_state
URL запроса: https://chatter.salebot.pro/api/#{api_key}/get_order_state
Разрешение доступа при генерации ключа: "Разрешение на чтение информации из CRM":
Path
api key* - токен доступа
Body
client_id - идентификатор клиента
order_id - Индентификатор сделки (если не указан, то метод вернет ID этапа текущей сделки)
Какие еще есть возможности
Проверка, есть ли Whatsapp* на номере телефона
GET https://chatter.salebot.pro/api/#{api_key}/check_whatsapp *
URL запроса: https://chatter.salebot.pro/api/#{api_key}/check_whatsapp
Чтобы использовать метод, у вас должен быть подключен Whatsapp* к Salebot.
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Вызывается как с методом GET, так и POST Номер телефона можно передавать в любом формате.
Path
api key* - токен доступа
Body
phone - Номер телефона для проверки
Получить список подключенных мессенджеров к проекту
GET https://chatter.salebot.pro/api/<api_key>/connected_channels
URL запроса: https://chatter.salebot.pro/api/<api_key>/connected_channels
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Функция возвращает к каждому мессенджеру параметр group_id, именно его необходимо передавать при загрузке клиентов. Для Whatsapp также возвращается поле status, которое принимает значения: NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3
Path
api key* - токен доступа
Получение списка блоков из схемы бота
GET https://chatter.salebot.pro/api/<api_key>/get_messages
URL запроса: https://chatter.salebot.pro/api/<api_key>/get_messages
Разрешение доступа при генерации ключа "Разрешение на чтение информации о клиентах":
Path
api key* - токен доступа
Получение вложенных данных клиента
delimiter
Для получения client_id и/или телефона клиента, которые лежат не на первом уровне, а во вложенных словарях, воспользуйтесь параметром delimiter:
Для этого к URL запроса добавьте:
?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
где
?delimiter=1 - параметр со значением. Данное значение разделяет ключи {key1}1{key2}1{key3}
delimiter_value_client_id={key1}1{key2} - получение ID клиента; delimiter_value_phone={key1}1{key2} - получение номера телефона клиента;
{key1} - ключ, в который вкладывается значение с ЛЮБЫМИ символами, кроме символов, лежащих в параметре. Ключей может быть неограниченное количество: ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. Ключ передается БЕЗ фигурных скобок.
Между ключами передавайте заданное значение delimiter!
если delimiter=2, то {key1}2{key2}2{key3}2,
delimiter=5, то {key1}5{key2}5{key3}5.
При присвоении значения delimiter=5, в ключе не должно быть символа 5 и т.д.
Пример:
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
Также можно получить только ID либо номер телефона: для этого после URL запроса добавьте один из необходимых запросов:
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2} - для получения ID клиента;
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1delimiter_value_phone={key1}1{key2} - для получения номера телефона;
Для методов API:
Запуск бота
https://chatter.salebot.pro/api/<api_key>/callback
Запуск бота по идентификатору пользователя ВКонтакте
https://chatter.salebot.pro/api/<api_key>/vk_callback
Запуск бота по номеру WhatsApp
https://chatter.salebot.pro/api/<api_key>/whatsapp_callback
Запуск бота по идентификатору пользователя Одноклассников
https://chatter.salebot.pro/api/<api_key>/ok_callback
Запуск бота по идентификатору Telegram
https://chatter.salebot.pro/api/<api_key>/tg_callback
Отправка callback-сообщения email-клиенту
https://chatter.salebot.pro/api/<api_key>/email_callback
Отправка сообщения клиенту
https://chatter.salebot.pro/api/<api_key>/message
8. Отправка сообщения в Whatsapp
https://chatter.salebot.pro/api/<api_key>/whatsapp_message
Массовая отправка сообщений
https://chatter.salebot.pro/api/<api_key>/broadcast
Присвоение переменных
https://chatter.salebot.pro/api/<api_key>/save_variables
Если вам нужны дополнительные методы, свяжитесь со службой поддержки.
Last updated