Система баллов API Calltouch
Описание системы баллов
Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов, рассчитывается индивидуально для каждого клиента и зависит от абонентской платы в месяц. Суточный лимит разделен на 24 часовых интервала.
В каждом интервале можно потратить 1/24 суточного лимита. Ограничение не более 5 запросов в секунду с одного IP-адреса. Например, если в 1 секунду с одного IP-адреса поступит 11 API-запросов, то 5 выполнятся сразу, а остальные API-запросы завершатся с ошибкой.
Время начала текущего интервала строго фиксированное - начало астрономического часа (например, с 15:00 до 15:59). Каждый успешный вызов метода API Calltouch влечет списание определенного количества баллов. При исчерпании почасового лимита вызов методов будет прекращен до наступления следующего часа. Доступные суточные и почасовые баллы отображаются в разделе
Интеграции /
Отправка данных во внешние системы => API и Webhooks:
Начисление баллов
Расчет количества суточных баллов осуществляется раз в сутки, они выдаются в 00:00. Неизрасходованные баллы за предыдущие сутки обнуляются.
Баллы, доступные для текущего часа, начисляются в начале текущего часа. Неизрасходованные баллы за предыдущий час обнуляются.
Списание баллов
За каждый успешно выполненный запрос списываются баллы в зависимости от стоимости метода и от кол-ва объектов. Ниже представлена таблица с методами API и количеством баллов за использование каждого:
Метод | URL | Экспорт/импорт | За успешный вызов | За объект |
---|---|---|---|---|
API-методы управления звонкам |
http://api.calltouch.ru/calls-service/RestAPI/{site_id}/calls-diary/calls | Экспорт | 1 | — |
https://api.calltouch.ru/calls-service/RestAPI/{site_id}/calls-diary/calls/{callId}/download | Экспорт | 1 | — | |
https://api.calltouch.ru/lead-service/v1/api/call/import | Импорт | 2 | 2 | |
https://api.calltouch.ru/lead-service/v1/api/call/import/log?logId={ID лога} | Экспорт | 1 | — | |
API-методы управления заявками |
https://api.calltouch.ru/calls-service/RestAPI/requests | Экспорт | 1 | — |
https://api.calltouch.ru/calls-service/RestAPI/requests/{site_id}/register/ |
Импорт | 2 | — | |
https://api.calltouch.ru/lead-service/v1/api/request/create | Импорт | 2 | 1 | |
API-методы управления сделками | https://api.calltouch.ru/calls-service/RestAPI/{site_id}/orders-diary/orders | Экспорт | 1 | — |
https://api.calltouch.ru/calls-service/RestAPI/orders/register |
Импорт | 4 | — | |
https://api.calltouch.ru/calls-service/RestAPI/orders/update-by-id/ | Импорт | 2 | — | |
https://api.calltouch.ru/calls-service/RestAPI/orders/delete-by-id/ | Импорт | 4 | — | |
https://api.calltouch.ru/lead-service/v1/api/client-order/create | Импорт | 4 | 2 | |
https://api.calltouch.ru/lead-service/v1/api/client-order/update | Импорт | 4 | 2 | |
https://api.calltouch.ru/lead-service/v1/api/client-order/find | Экспорт | 1 | — | |
https://api.calltouch.ru/lead-service/v1/api/client-order/delete | Импорт | 4 | 2 | |
API-методы управления тегами |
https://api.calltouch.ru/lead-service/v1/api/tag/lead/add |
Импорт | 4 | 2 |
https://api.calltouch.ru/calls-service/RestAPI/{site_id}/addtags | Импорт | 4 | — | |
https://api.calltouch.ru/calls-service/RestAPI/{site_id}/deletetags | Импорт | 4 | — | |
API-методы управления менеджерами |
http://api.calltouch.ru/calls-service/RestAPI/{site_id}/addmanager |
Импорт | 4 | — |
https://api.calltouch.ru/calls-service/RestAPI/{site_id}/deletemanager/ | Импорт | 4 | — | |
API-методы управления расходами |
https://api.calltouch.ru/report-service/RestAPI/api/costs-import/add |
Импорт | 4 | 2 |
https://api.calltouch.ru/report-service/RestAPI/api/costs-import/update | Импорт | 4 | 2 | |
https://api.calltouch.ru/report-service/RestAPI/api/costs-import/123/status | Экспорт | 1 | — | |
API-метод управления Callback | https://api.calltouch.ru/widget-service/v1/api/widget-request/user-form/create | Импорт | 4 | — |
API-методы импорта плановых метрик |
https://api.calltouch.ru/report-service/RestAPI/api/plans-import/add |
Импорт | 4 | 2 |
https://api.calltouch.ru/report-service/RestAPI/api/plans-import/123/status | Экспорт | 1 | — | |
API-метод удаления импортированных данных | https://api.calltouch.ru/report-service/RestAPI/api/users-import/delete | Импорт | 4 | 2 |
API-метод пользовательского события триггерных сценариев | https://api.calltouch.ru/lead-service/v1/api/calltouch-leads/custom-event | Импорт | 2 | — |
API-методы управления скорингами | https://api.calltouch.ru/scoring-service/v1/api/calltouch-scoring/create | Импорт | 2 | 2 |
https://api.calltouch.ru/scoring-service/v1/api/multisite/calltouch-scoring/create | Импорт | 2, списываем в проекте где создан скоринг | — | |
https://api.calltouch.ru/scoring-service/v1/api/calltouch-scoring/123/result | Экспорт |
- 200, если 200ок и статус Скоринга "Завершен" - 2, если 200ок и статус Незавершен |
— |
Ответы API
В ответах API можно узнать:
- количество оставшихся баллов после выполнения метода;
- ошибки, связанные с исчерпанием баллов.
Подробная информация указана ниже.
HTTP-заголовок с баллами
Во всех описанных методах транслируется HTTP-заголовок Api-Points. Заполнятся по формату:
Api-Points: потраченное количество баллов за запрос/оставшееся количество почасовых баллов/оставшееся количество суточных баллов
Пример сформированного заголовка:
Api-Points: 4/5256/102368
Исчерпание часового лимита
При исчерпании часовых баллов транслируется ошибка (HTTP-код ответа - 429) с текстом:
{
"meta": [],
"data": {
"type": "apiError",
"apiErrorData": {
"errorCode": 90001,
"errorMessage": "Исчерпан часовой лимит баллов по сайту",
"errorDescription": null
},
"validationErrorData": null
}
}
и мы поможем вам
- Дашборд (раздел «Общая информация»)