API
Взаимодействие с сервисом осуществляется по протоколу HTTP посредством GET и POST запросов. Данные POST-запросов передаются в формате JSON.
Авторизация
Перед началом взаимодействия с сервисом необходимо выполнить авторизацию и получить идентификатор сессии, который должен передаваться во все последующие запросы. Для авторизации в сервисе необходимо выполнить GET-запрос:
http://sms.ximart.ru/sms_server2/hs/API/V1/authorization?login=<Логин>&password= <Пароль>
При успешном выполнении сервис вернет ответ:
{
"session": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"phone": "+7(9**)***-04-22",
"company": "ООО Ксимарт"
}
Описание методов
Все запросы к сервису имеют вид:
http://sms.ximart.ru/sms_server2/hs/API/V1/{имя метода}?session={идентификатор сессии}&{другие параметры метода}
При успешном выполнении запроса сервис возвращает ответ в формате JSON, при возникновении ошибки сервис возвращает текст ошибки.
Числа должны передаваться в виде строки в формате XXXXXX.XX, даты - в формате ГГГГММДД.
Проверить актуальность сессии
Имя метода: check_session
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
Параметры ответа
company Название компании Строка
phone Номер телефона Строка
Завершить сессию
Имя метода: finish_session
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
Параметры ответа
success Успешное выполнение Булево
Получить баланс счета
Имя метода: get_balance
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
Параметры ответа
balance Баланс счета Строка
Получить рассылки
Имя метода: get_mailings
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
start_date Дата начала Строка Нет
finish_date Дата окончания Дата Нет
Параметры ответа
mailings Список рассылок Массив
date Дата рассылки Дата
code Код рассылки Строка
name Название рассылки Строка
quantity Количество сообщений в рассылке Строка
sent Количество отправленных Строка
delivered Количество доставленных Строка
not_delivered Количество недоставленных Строка
Получить сообщения рассылки
Имя метода: get_messages
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
code Код рассылки Число Да
Параметры ответа
messages Список сообщений Массив
code Код сообщения Дата
phone Номер телефона абонента Строка
text Текст сообщения Строка
status Статус сообщения Строка
Получить статусы сообщений
Имя метода: get_statuses
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
code Код рассылки Число Да
Параметры ответа
messages Список сообщений Массив
code Код сообщения Дата
status Статус сообщения Строка
Создать рассылку
Имя метода: create_mailing
Тип запроса: POST
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
name Название рассылки Строка Да
Параметры ответа
code Код рассылки Строка
message Код последнего сообщения рассылки Строка
Получить отчет по балансу
Имя метода: get_report
Тип запроса: GET
Параметры:
Параметр Описание параметра Тип Обязательный
Параметры запроса
session Идентификатор сессии Строка Да
start_date Дата начала Строка Да
finish_date Дата окончания Дата Да
Параметры ответа
start_balance Начальный баланс Число
transactions Движения по счету Массив
date Дата операции Дата
direction Тип операции Строка
description Описание операции Строка
quantity Количество сообщений Число
price Цена сообщения Число
amount Сумма операции Число