ЦеныИндивидуальная сборка
ВойтиНачать бесплатно
Единый инбоксВсе чаты в одном спискеИсточники лидовРеклама или страница, открывшая чатАвтоответыСразу отвечают, и в нерабочее времяОтчётыСкорость ответов и отчёт по понедельникамЗаписиПросмотры и приёмы прямо из чатаПриложениеТот же инбокс на телефонах командыВебхуки и календарьЧаты и записи в ваши системы
Все каналыЧетыре канала в одном инбоксеWhatsAppВаш номер через официальную платформу MetaInstagramDirect и ответы на сторисMessengerПереписка вашей страницы FacebookЧат на сайтеЧат на вашем сайте, уже сегодня
Интернет-магазиныКлиники и стоматологииАвтосалоныНедвижимость и застройщикиОтели и гостевые домаСалоны красотыРестораны и доставкаФитнес и студииШколы и курсыРемонт и услуги

Все отрасли →

API данных

Как ваша система держит список в mpulse актуальным: один запрос, когда позиция меняется, и AI-ассистент отвечает по нему уже на следующее сообщение.

На этой странице

КлючЗапросыЧто возвращаетсяПримерыПорядок, повторы и удалениеЛичные данныеЛидыОшибкиОграничения
  1. Ключ
  2. Запросы
  3. Что возвращается
  4. Примеры
  5. Порядок, повторы и удаление
  6. Личные данные
  7. Лиды
  8. Ошибки
  9. Ограничения

Ключ

Каждый запрос несёт ключ в заголовке: Authorization: Bearer mpk_live_… Ключи делает владелец на карточке списка; каждый показывается один раз.

Начните с тестового ключа (mpk_test_…). Он пишет в тестовую часть списка, которую агент никогда не читает, и не добавляет полей в список: присланное им поле возвращается с предупреждением new_field и в поля списка не попадает, поэтому GET /sources/{list} показывает только поля, которые прислал рабочий ключ. Когда всё работает, переходите на рабочий ключ.

Ключу место на сервере. Никогда не вставляйте его в веб-страницу и в адрес: ключ, отправленный в адресе, сразу отключается.

Запросы

https://app.mpulse.ge/api/v1

GET/meчей ключ и к каким спискам у него доступ
GET/sources/{list}поля списка, что значит каждое значение, поля id и версии
PUT/sources/{list}/items/{id}одна позиция целиком: создаётся или заменяется
PATCH/sources/{list}/items/{id}меняются только присланные поля; null удаляет поле
POST/sources/{list}/items?mode=mergeid в теле; новую позицию создаёт
DELETE/sources/{list}/items/{id}?version=убирает из списка
POST/sources/{list}/batchдо 500 сразу: {"upsert": [...], "delete": [...]}
GET/sources/{list}/items/{id}одна позиция в том виде, в каком она есть в mpulse (для ключей с чтением); если в id есть /, используйте /items?id=
GET/sources/{list}/items?since=все изменения после курсора, включая удаления (для ключей с чтением)
GET/leadsоткуда пришёл каждый клиент, в порядке сохранения (для рабочих ключей с чтением и включёнными лидами)

Что возвращается

Запись возвращает {"object": "item", "id", "version", "seq", "changed", "warnings"}. В changed перечислены изменившиеся поля (пусто, если ничего не изменилось), в warnings то, что сохранено с замечанием (коды ниже), а seq показывает место позиции в порядке изменений списка. Ключ с правом чтения получает и саму позицию в data, с полями, которые владелец включил: новое для списка поле сохраняется, но не попадает в data (и в GET /items), пока владелец его не посмотрит, поэтому один раз присланные цена и статус могут пока не показываться. Ответ тестовому ключу возвращает все присланные поля, и новые тоже, потому что тестовая сторона не добавляет полей в список: в ответе рабочему ключу их может быть меньше. Ключ, которому владелец разрешил читать скрытые поля, получает все. С ?dry_run=true ответ тот же, плюс "dry_run": true, и ничего не сохраняется.

batch возвращает счётчики: {"object": "batch", "created", "updated", "unchanged", "deleted", "stale", "failed", "errors", "warnings"}. У каждой ошибки и предупреждения есть индекс операции и id.

GET /items возвращает {"object": "list", "data": [...], "has_more", "next_cursor"}, начиная со старых изменений. Для следующей страницы передайте next_cursor как ?cursor=. Сохраните последний: позже ?since= с этим значением вернёт только то, что изменилось после него, включая удалённые позиции в виде {"id", "deleted": true, "version"}. since=0 начинает с самого начала.

GET /items/{id} возвращает позицию, {"object": "item", "id", "data", "version", "seq", "created_at", "updated_at"}, или 404 item_not_found (для удалённой с "deleted": true).

Примеры

export MPULSE_KEY=mpk_test_...    # сначала тестовый ключAPI=https://app.mpulse.ge/api/v1SRC=<list id>AUTH="Authorization: Bearer $MPULSE_KEY"JSON="Content-Type: application/json" # Ключ верный и к чему у него доступ?curl -s $API/me -H "$AUTH" # Поля списка и что значит каждое значениеcurl -s $API/sources/$SRC -H "$AUTH" # Что произойдёт, ничего не записываяcurl -s -X PUT "$API/sources/$SRC/items/A-12?dry_run=true" \  -H "$AUTH" -H "$JSON" \  -d '{"apartment_no":"A-12","price":128000,"status":"A",       "updated_at":"2026-11-11T14:02:11+04:00"}' # Одна позиция целиком (создаётся или заменяется)curl -s -X PUT "$API/sources/$SRC/items/A-12" \  -H "$AUTH" -H "$JSON" \  -d '{"apartment_no":"A-12","price":128000,"status":"A",       "updated_at":"2026-11-11T14:02:11+04:00"}' # Продано: меняется только это, версией служит время вашей системыcurl -s -X POST "$API/sources/$SRC/items?mode=merge" \  -H "$AUTH" -H "$JSON" -H "Idempotency-Key: deal-8812-sold" \  -d '{"apartment_no":"A-12","status":"S",       "updated_at":"2026-11-11T15:00:00+04:00"}' # Убрать из спискаcurl -s -X DELETE -H "$AUTH" \  "$API/sources/$SRC/items/A-12?version=2026-11-11T16:00:00%2B04:00" # Много сразу, до 500 за запрос: {"upsert": [...], "delete": [...]}KEY=load-$(shasum -a 256 items-1.json | cut -c1-40)curl -s -X POST "$API/sources/$SRC/batch" \  -H "$AUTH" -H "$JSON" -H "Idempotency-Key: $KEY" \  -d @items-1.json

JavaScript работает на Node 18 и новее, без библиотек. Добавьте ?dry_run=true к любой записи, чтобы увидеть ответ, ничего не сохраняя.

Порядок, повторы и удаление

Если у списка есть поле версии, оно нужно в каждой записи, и запись старее той, что есть в mpulse, получает 409 stale_version и ничего не меняет. Считайте её выполненной.

Удаление оставляет метку со своей версией, поэтому запоздалый повтор не вернёт позицию.

Отправляйте заголовок Idempotency-Key с каждой записью (id вашего события подойдёт). Повтор с тем же ключом получит тот же ответ.

Личные данные

mpulse никогда не хранит имя, телефон, почту или личный номер покупателя. Такие поля, как buyer_phone, отбрасываются, и ответ содержит предупреждение personal_dropped. Владелец может вместо этого отклонять такие записи.

Лиды

GET /leads показывает, откуда пришёл каждый клиент, по записи на каждый сигнал: реклама, ссылка, переход на сайт бизнеса по размеченной ссылке или источник, который команда указала вручную. Нужен рабочий ключ, которому можно читать (только читать или читать и писать), с включёнными лидами. Тестовый ключ получит 403 live_key_required, потому что в лидах настоящие клиенты; любой другой ключ получит 403 scope_missing. GET /me показывает права ключа (scopes).

Каждая запись: {"object": "lead", "id", "at", "stored_at", "kind", "channel", "conversation_id", "contact": {"id", "name", "phone", "email"}, "source": {"key", "name", "source", "medium"}, "campaign": {"id", "name"}, "adset": {"id", "name"}, "ad": {"id", "name", "title"}, "utm", "clicks", "role", "clicked_at", "referrer", "landing", "page", "ref", "manual", "handoff"}. Поле at хранит время самого сигнала (реферала, сообщения, с которым пришёл визит на сайт, или момента, когда источник указали вручную), поэтому оно не следует порядку ленты; stored_at показывает, когда mpulse сохранил лид: в этом порядке идёт лента. kind бывает ad, link, web или manual. У лида с сайта есть role (first: визит, который сайт запомнил первым; last: последний) и clicked_at, когда был этот визит; у остальных там null. В manual лежит источник, который команда указала вручную, с причиной и тем, кто его указал; manual.overrides содержит id автоматического лида, который он заменил: синхронизации больше не стоит его учитывать. handoff заполнен у лида, который чат WhatsApp перенял из чата на сайте, когда посетитель нажал «Продолжить в WhatsApp»: {"from": id лида чата на сайте, который он повторяет, или null, если у того чата лида не было, "conversation_id": чат на сайте}. Это тот же клиент, который продолжает разговор: синхронизации не стоит считать его ещё раз; у остальных лидов там null. source.name приходит на языке из Accept-Language запроса (en, ka или ru), иначе по-английски.

?limit=1..100 (50), ?cursor= или ?since= с next_cursor прошлого ответа (since=0 начинает сначала), ?created_since= дата и время в ISO 8601 со смещением (2026-11-01T00:00:00Z или 2026-11-01T00:00:00+04:00: то, что mpulse сохранил с этого момента), ?kind= и ?source= (google или google:cpc вместе с medium). На любой другой параметр ответ 400 unknown_param. Ответ: {"object": "list", "data", "has_more", "next_cursor"}, в том порядке, в каком mpulse сохранял лиды: верните next_cursor, чтобы получить следующую страницу, а последний сохраните, чтобы потом запросить только то, что пришло после него. Лид, который ещё сохраняется, ждёт следующего запроса, поэтому сохранённый курсор ни одного не пропустит.

Лента только пополняется. Каждый лид приходит один раз, таким, каким он был при чтении, а то, что меняется потом, повторно не отправляется: названия рекламы Meta, которые появляются, когда владелец разрешит mpulse читать рекламу бизнеса, объединение двух людей в одного, отменённый источник, указанный вручную, удалённый чат или клиент. Чтобы учесть это, перечитывайте недавний период с ?created_since= (например, последние 7 дней раз в день) и обновляйте сохранённое по id; лид, который в этом периоде больше не приходит, удалён.

В лиде есть имя, телефон и почта клиента, как в инбоксе. Храните ключ на своём сервере, а прочитанное берегите так же, как mpulse.

Ошибки

Любой отказ выглядит так: {"error": {"type", "code", "message", "request_id", "doc_url", "details"}}. В details каждое поле, которое не подошло, и причина; doc_url ведёт к строке этого кода ниже.

401 ключ; 403 что ключу можно; 404 нет такого списка или позиции; 409 stale_version или полный список; 413 слишком большой; 415 не JSON; 422 позиция не подошла; 429 помедленнее (Retry-After).

Код отказа (error.code) или предупреждения в ответе на запись (warnings[].code).

missing_key401. Запрос пришёл без ключа. Передайте его в заголовке: Authorization: Bearer mpk_…
invalid_key401. Это не наш ключ. Проверьте, что он скопирован целиком, вместе с началом mpk_live_ или mpk_test_.
key_revoked401. Владелец отключил этот ключ. Попросите новый.
key_expired401. Срок ключа истёк. Попросите у владельца новый.
key_in_url400. Ключ был в адресе, где его записывают в журналы серверы и прокси. Рабочий ключ, отправленный так, сразу отключается: попросите новый и передавайте его только в заголовке.
key_in_body400. Ключ был в теле запроса (в значении, имени поля или id), где он сохранился бы и был бы виден. Ничего не записано, а рабочий ключ, отправленный так, сразу отключается: попросите новый и передавайте ключи только в заголовке Authorization.
api_not_enabled403. API данных для этого рабочего пространства ещё не включён.
write_only_key403. Ключ может только писать. Для чтения нужен ключ с правом чтения.
read_only_key403. Ключ может только читать.
source_not_allowed403. У ключа нет доступа к этому списку. Владелец может добавить список к ключу.
not_found404. В этом рабочем пространстве нет списка с таким id.
item_not_found404. Позиции с таким id нет. Слияние (PATCH) меняет только существующую; POST /items?mode=merge её создаст.
source_not_api409. Этот список читается по адресу или из файла. Писать можно только в список, который присылает ваша система.
json_only415. Отправляйте тело как JSON с заголовком Content-Type: application/json.
bad_json400. Тело не является корректным JSON.
too_large413. Больше 64 КБ на позицию или 1 МБ на batch. Разделите.
too_many_operations422. Больше 500 операций в одном batch.
bad_mode400. mode бывает replace или merge.
bad_limit400. limit от 1 до 100.
bad_cursor400. cursor и since берут значение next_cursor из прошлого ответа; updated_since дату и время в ISO 8601.
bad_idempotency_key400. Idempotency-Key должен содержать от 1 до 255 печатных символов.
idempotency_mismatch422. Этот Idempotency-Key за последние 24 часа уже был у другого запроса. Для нового запроса нужен новый ключ.
idempotency_in_progress409. Первый запрос с этим Idempotency-Key ещё выполняется. Повторите после Retry-After.
rate_limited429. 300 запросов в минуту на ключ и 600 на рабочее пространство. Подождите Retry-After секунд.
invalid_item422. Значения не подошли к полям списка. В details каждое: param, code, message.
stale_version409. В mpulse уже есть более новая версия этой позиции, поэтому ничего не изменилось. Считайте выполненным.
source_full409. В списке 5 000 позиций, больше не помещается (в тестовой части 500).
id_required422. Позиции нужен id: в поле id списка или в адресе.
bad_id422. id должен быть строкой или целым числом, от 1 до 200 символов.
id_mismatch422. id в теле не совпадает с id в адресе.
personal_id422. id похож на личные данные (почта, телефон, личный номер), которые mpulse никогда не хранит. Используйте свой id позиции; 11-значный код товара пройдёт, когда владелец отметит поле как не личное.
version_required422. Список упорядочивает записи по полю версии: оно нужно в каждой записи, а при удалении как ?version=.
bad_version422. Версия задаётся числом (счётчик, epoch в миллисекундах) или датой и временем в ISO 8601.
personal_data422. В поле личные данные, и владелец выбрал отклонять такие записи, а не отбрасывать.
not_an_object422. Позиция должна быть JSON-объектом.
bad_key422. Имя поля от 1 до 64 символов, без точек, не начинается с $ или _mp.
too_deep422. Объекты вкладываются не глубже трёх уровней.
not_supported422. Список объектов пока не принимается: отправляйте значения каждой строки отдельными полями.
too_many_values422. В списке значений не больше 50.
bad_value422. Значение, которое JSON не передаёт как текст, число или true/false.
too_long422. Значение не длиннее 500 символов.
unknown_field422. Владелец закрыл набор полей, и этого среди них нет.
too_many_fields422. В списке не больше 50 полей.
not_a_number422. Поле хранит числа: отправляйте 128000, а не "128 000", или добавьте ?typecast=true.
ambiguous_number422. "1.250" или "1,250" читается двояко, поэтому не угадывается даже с typecast. Отправьте JSON-число.
not_a_boolean422. Поле принимает true или false; с ?typecast=true также yes, no, 1 и 0.
not_a_date422. Дату пишите как 2026-11-14 или как дату и время в ISO 8601 с Z или смещением.
not_a_link422. Ссылка начинается с http:// или https://.
not_text422. Поле хранит текст: отправьте строку или добавьте ?typecast=true.
new_fieldПредупреждение. Поле, которого в списке не было. От рабочего ключа оно сохраняется, но выключено, пока владелец его не посмотрит: агент его не читает, и при чтении ключом его нет в data. От тестового ключа хранится только в тестовой части, и поля списка не меняются.
new_valueПредупреждение. Значение, которого у поля не было (статус "B"): сохранено, владельца спросят, что оно значит.
personal_droppedПредупреждение. Поля с личными данными отброшены, остальное записано. Названы поля, но никогда не значения. Если само имя поля было личными данными (номер телефона вместо имени поля), param пустой: такое имя мы никогда не повторяем.
encodingПредупреждение. В значении символ �: текст, вероятно, отправлен не в UTF-8.
internal500. Что-то пошло не так на нашей стороне. Повторите с тем же Idempotency-Key, а если повторится, пришлите нам request_id.
live_key_required403. В лидах данные настоящих клиентов, а тестовый ключ их никогда не читает. Используйте рабочий ключ с включёнными лидами.
scope_missing403. Этому ключу нельзя читать лиды. Владелец включает лиды для рабочего ключа, которому можно читать.
bad_created_since400. created_since: дата и время в ISO 8601 со смещением, например 2026-11-01T00:00:00Z или 2026-11-01T00:00:00+04:00; время без смещения мы не угадываем.
unknown_param400. /leads принимает limit, cursor (или since), created_since, kind и source; любой другой параметр отклоняется, чтобы опечатка не прочиталась как весь список.
bad_filter400. kind бывает ad, link, web или manual; source называет источник (google) или источник с его medium (google:cpc).

Ограничения

300 запросов в минуту на ключ, 5 000 позиций в списке, 500 операций и 1 МБ в batch, 64 КБ на позицию, 500 символов в значении. Числа строго: отправляйте 128000, а не "128 000" (или добавьте typecast=true).

Грузинская платформа для переписки с клиентами.

info@mpulse.ge
Тбилиси, Грузия

Продукт

  • Единый инбокс
  • Откуда пришёл каждый лид
  • Автоответы
  • Отчёты
  • Записи
  • Приложение для телефона
  • Вебхуки и календарь
  • Цены
  • Индивидуальная сборка

Каналы

  • Каналы
  • WhatsApp
  • Instagram
  • Messenger
  • Чат на сайте

Отрасли

  • Отрасли
  • Недвижимость и застройщики
  • Клиники и стоматологии
  • Салоны красоты
  • Автосалоны
  • Интернет-магазины
  • Рестораны и доставка
  • Отели и гостевые дома
  • Фитнес и студии
  • Школы и курсы
  • Ремонт и услуги

Сравнение

  • Сравнение
  • mpulse или приложение WhatsApp Business
  • mpulse или таблица и три телефона
  • mpulse или Bitrix24
  • mpulse или FollowUP

Компания

  • Войти
© 2026 mpulse
КонфиденциальностьУсловияУдаление данных