AIMen Inbox/API для разработчиков
AIMen Inbox APIWhatsApp, Instagram и Telegram
в вашем продукте
API AIMen Inbox: отправляйте и получайте сообщения клиентов из своей CRM, сайта или сервиса. Работу с Meta — Tech Provider, Business Verification, токены и вебхуки — берёт на себя Inbox, вы работаете с одним API.
Два способа работать с API Inbox
Своя интеграция
У вас аккаунт AIMen Inbox — подключите к нему CRM, сайт или бота. Ключ создаётся в Настройках → API-ключи, там же адрес вебхука для входящих.
Партнёрам
Ваш продукт подключает WhatsApp и Instagram своим клиентам: организация на каждого клиента и наш виджет подключения внутри вашего интерфейса.
От запроса до первого сообщения клиента — четыре шага
Провижининг организации
Одним запросом с вашим партнёрским ключом создаёте организацию для клиента — идемпотентно, по вашему собственному ID. Ключ этой организации выдаётся один раз, сразу в ответе.
Виджет подключения
Получаете embed-ссылку и вставляете её iframe’ом в свой интерфейс. Пользователь проходит подключение WhatsApp или Instagram, ничего не покидая ваш продукт и не заводя отдельный логин.
Отправка и приём сообщений
Отправляете сообщения и одобренные шаблоны через API. Входящие от клиента прилетают вам вебхуком в реальном времени, с подписью для проверки подлинности.
Готово
Дальше — обычная работа: статус канала, шаблоны и их модерация, диалоги — всё доступно через тот же API, без интерфейса Inbox.
Один запрос — и клиент готов к подключению канала
curl -X POST https://inbox.aimen.kz/api/partner/v1/organizations \
-H "Authorization: Bearer <partner_key>" \
-H "Content-Type: application/json" \
-d '{
"externalId": "client-482",
"name": "ТОО Ромашка"
}'
# { "data": { "organizationId": "...", "created": true,
# "apiKey": "aimen_live_..." } }Что уже готово в API
Два уровня ключей
Партнёрский ключ — провижинит организации. Ключ организации — работает только с одним вашим клиентом.
Готовый виджет подключения
WhatsApp Embedded Signup и Instagram OAuth — уже реализованы, вставляются iframe’ом в ваш продукт.
Отправка сообщений и шаблонов
Текст в рамках 24-часового окна WhatsApp или одобренный шаблон вне его — одним и тем же вызовом.
Вебхук на входящие
Подписанные события в реальном времени вместо опроса API — на общий адрес для всех ваших клиентов.
Статус и ограничения канала
Блокировки и ограничения Meta видны через API, чтобы отразить их в своём интерфейсе, не отправляя клиента в Inbox.
Управление шаблонами
Создание, отправка на модерацию и статус — черновик, на проверке, одобрен, отклонён с причиной.
Если вы делаете CRM, агента бронирования или любой продукт, где клиенту нужен WhatsApp или Instagram
Ваши конечные пользователи никогда не видят интерфейс AIMen Inbox и не заводят в нём отдельный аккаунт — для них всё происходит внутри вашего продукта. Прямые переговоры с Meta, хранение токенов доступа, приём и проверка вебхуков — остаются на нашей стороне.
Подключитесь к API Inbox
Своя интеграция — создайте ключ в Настройках AIMen Inbox и начните по документации. Партнёрам — напишите нам: расскажем, как встроить подключение канала в ваш продукт, и выдадим партнёрский ключ.