API для заявок и звонков
Простой HTTP API с ключами компании: создавайте заявки с любого сайта и передавайте звонки и записи разговоров из своей АТС.
Небольшой API, который легко подключить
Только HTTPS и метод POST. Тело запроса в JSON или обычной формой, ответ всегда в JSON.
Заявки
POST /api/v1/leads
Заявка с формы сайта, квиза или вашего сервиса. Достаточно имени, телефона или email.
Звонки
POST /api/v1/calls
События звонка из АТС: начало, итог, длительность и ссылка на запись разговора.
Записи файлом
POST /api/v1/calls/recording
Для АТС, которые не дают публичную ссылку на запись: файл загружается отдельным запросом.
Звонок из АТС одним запросом
Передайте идентификатор звонка и номер клиента. CRM сама найдёт активную заявку с этим номером или создаст новую по входящему.
- Ключ в заголовке
X-API-KeyилиAuthorization: Bearer. В адресе запроса ключ не принимается. - Номер заявки в ответеТот же номер менеджеры видят в списке заявок.
- Неизвестные поля не мешаютЛишнее в запросе молча игнорируется.
Отдельный ключ на каждую интеграцию
Форма сайта, телефония и чат-бот работают на своих ключах. Если один попал к посторонним, отзываете только его.
- Ключ привязан к компанииВсё, что приходит с ключом, попадает в эту компанию.
- Значение показывается один разCRM хранит только отпечаток ключа и показать его снова не может.
- Отзыв действует сразуУ компании может быть до 20 действующих ключей.
Заявка не должна потеряться по дороге
Безопасные повторы
Не получили ответ? Отправьте запрос ещё раз: дубля не будет.
Понятные ошибки
Код ошибки, сообщение и список причин в каждом отказе.
Запас по лимитам
До 3000 запросов за 5 минут на один ключ.
Номер запроса
В каждом ответе есть заголовок X-Request-ID для обращения в поддержку.
Вопросы об API
Где взять ключ API?
Можно ли вызывать API прямо из кода страницы сайта?
Что умеет API?
POST /api/v1/leads), передать событие звонка (POST /api/v1/calls) и загрузить запись разговора файлом (POST /api/v1/calls/recording). Чтения данных из CRM в API нет.Что делать, если запрос не прошёл?
Что будет с ключом, если сотрудник, который его выпустил, уйдёт?
Соберите все заявки в одном месте
Регистрация по коду из письма занимает минуту. Банковская карта не нужна.
Начать бесплатно