API-документация
Это документация по доступным API‑эндпоинтам, построенным на основе архитектуры REST. Все API‑эндпоинты возвращают JSON‑ответ со стандартными HTTP‑кодами ответа и требуют Bearer-аутентификацию через API‑ключ.
Аутентификация
Все API-эндпоинты требуют API-ключ, передаваемый методом Bearer Authentication.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://sms.ecofon.business/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://sms.ecofon.business/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Ошибки
Наш API использует стандартные HTTP-коды состояния, чтобы указать, был ли запрос выполнен успешно или с ошибкой.
{
"errors": [
{
"title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
"status": 401
}
]
}
200 Запрос успешно выполнен
400 Некорректный запрос — обязательные параметры отсутствуют или указаны неверно
401 Ошибка авторизации — API-ключ отсутствует или указан неверно
404 Запрашиваемый ресурс не найден
429 Слишком много запросов — превышен лимит запросов
500 Внутренняя ошибка сервера — проблема на нашей стороне
Все результаты API работают в часовом поясе UTC, если не указано иное.
Пользователь
Контакты
Статистика контактов
SMS
Устройства
Кампании
RSS-автоматизации
Регулярные кампании
Авто-сценарий
Сегменты
Тригеры уведомлений
Команды
Участники команды
Участник команды
История платежей.
Журнал активности