Общая информация

JSON API является наиболее полнофункциональным среди всех API, разработанных YESMS. Для вызова используются запросы POST поверх HTTPS-соединения. Формат запроса и ответа - JSON.

Адрес API

https://api.yesms.ru/json/2020-01-01

Опциональные заголовки HTTP

Content-type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

Формат запроса

{
    "api_key": string,
    "action": string,
    "data": object
}

Формат ответа на успешно обработанный запрос

{
    "success": boolean,
    "data": object
}

Формат ответа на запрос с ошибкой

{
    "success": boolean,
    "error": string
}

Возможные ошибки

Ошибка	Описание
REQUEST-INVALID-FORMAT	Запрос имеет недопустимый формат
REQUEST-API-KEY-REQUIRED	Не указан параметр auth_key
REQUEST-API-KEY-INVALID-TYPE	Параметр auth_key имеет недопустимый тип
REQUEST-API-KEY-INVALID-FORMAT	Параметр auth_key не соответствует формату
REQUEST-API-KEY-NOT-FOUND	Ключ API не найден
REQUEST-API-KEY-NOT-SUPPORTED	Ключ API не совместим с используемым типом или версией API
REQUEST-ACTION-REQUIRED	Не указан параметр action
REQUEST-ACTION-INVALID-TYPE	Параметр action имеет недопустимый тип
REQUEST-ACTION-INVALID-FORMAT	Параметр action не соответствует формату
REQUEST-ACTION-NOT-SUPPORTED	Параметр action имеет недопустимое значение
REQUEST-DATA-REQUIRED	Не указан параметр data
REQUEST-DATA-INVALID-TYPE	Параметр data имеет недопустимый тип
REQUEST-DATA-INVALID-FORMAT	Параметр data не соответствует формату

Методы API

Метод	Описание
blacklist-create	Добавление номера телефона в черный список
blacklist-remove	Удаление номера телефона из черного списка
blacklist-search	Поиск номеров в черном списке
blacklist-update	Обновление записи в черном списке
phonebook-create	Создание телефонного справочника
phonebook-remove	Удаление телефонного справочника
phonebook-search	Поиск телефонных справочников
phonebook-create	Создание телефонного справочника
phonebook-remove	Удаление телефонного справочника
phonebook-search	Поиск телефонных справочников
sms-calculate	Подсчет стоимости одиночного сообщения SMS
sms-cancel	Отмена отправки одиночного сообщения SMS
sms-create	Создание одиночного сообщения SMS
sms-pause	Приостановка отправки сообщения SMS
sms-resume	Возобновление отправки сообщения SMS
sms-status	Получение статуса сообщения SMS
sms-signature-remove	Удаление подписи отправителя SMS
sms-signature-search	Поиск подписей отправителя SMS