Этот документ хоть и работает, но устарел. См - SMS

advertisement
Этот документ хоть и работает, но устарел. См. новую версию API
API для сервисов «СМС-оценка» и «СМС-голосование»
sms-vote.ru
СМС-оценка (с запросом и без него)
Формат api-запросов для отправки клиентам СМС-сообщений с просьбой оценить ваш сервис и получения
результатов с оценками.
Услуга «СМС-оценка» может функционировать в двух режимах: с запросом и без запроса.


Если вам известны номера телефонов ваших клиентов, то вам подходит «СМС-оценка» с запросом: клиенту
отправляется СМС-сообщение, на которое тот отвечает цифрой с оценкой + опциональный комментарий (см.
п. 1 ниже).
Если номера телефонов клиентов неизвестны, то следует воспользоваться «СМС-оценкой» без запроса:
клиент сам должен отправить ваш префикс + оценка + опциональный комментарий на номер услуги. Таким
образом, вам требуется только информация по полученным оценкам – см. п. 2 ниже.
Обратитесь к администрации для выделения вам префиксов.
1. Отправка СМС-сообщений с просьбой оценить ваш сервис
Пример для демо-пользователя на сайте sms-vote.ru (id=52):
http://sms-vote.ru/api/c1api.php?json={"id":52,"job":"sms","current_date":"20140620105245",
"sms":[{"phone_to":79210001122,"employee_nr":"Employee","order_nr":"Order","text":"Please
valuate our service: 1 to 5","text_final":"Thanks!"}],
"secure":"655c6852dd9e7d4f4acd03954770f972"}
job
sms
id
ваш номер из Личного кабинета
secure
хэш. secure = md5($user_id.$current_date.$user['secret']).
Получается путём MD5-преобразования вашего id, текущей даты и секретного ключа,
доступных в Личном кабинете. Преобразовать вручную можно на сайте
http://www.md5.cz/
Например, для пользователя с id=52 (демо-юзер) секретный ключ из Личного кабинета
равен 7XzTBv12NjMGfb7f3jnV.
Введя на указанном сайте 52201406201052457XzTBv12NjMGfb7f3jnV (id + current_date +
секретный ключ) получаем искомый secure 655c6852dd9e7d4f4acd03954770f972
current_date
текущая дата и время в формате ГГГГММДДЧЧММСС. Требуется для расчета secure (см.
выше). Параметр current_date можно зафиксировать и не менять.
phone_to
номер телефона клиента, которому отправляется СМС с просьбой оценить сервис.
Например, 79210001122
employee_nr
название вашего подразделения или менеджера (продавца) выполнившего заказ
(необязательно). Полезно для аналитики в разрезе сотрудников.
order_nr
ваш внутренний номер заказа (необязательно). Полезно для аналитики в разрезе
заказов.
text
текст СМС вашему клиенту, например:
Пожалуйста, оцените наш сервис. Отправьте цифру от 1 до 5 и ваш комментарий (по
желанию) в ответном СМС
text_final
текст завершающего СМС вашему клиенту, после того, как клиент прислал оценку.
Например: Спасибо за ваш ответ!
 New! Тексты завершающего СМС могут быть заданы индивидуально для каждой
оценки клиента: 1, 2, 3, 4 и 5. См. раздел Настройки
 По желанию, для СМС-сообщений с просьбой оценить ваш сервис вы можете
установить задержку перед отправкой посредством данного API. Это полезно
чтобы СМС уходила клиенту не сразу после закрытия заказа, а через некоторое
время. См. раздел Настройки
В команде поддерживается передача сразу нескольких СМС. Они перечисляются внутри квадратных скобок:
"sms":[{},{}…]
2. Выгрузка оценок клиентов вашего сервиса за период времени
Клиенты могут присылать свои оценки как в ответ на запрос с вашей стороны (услуга «СМС-оценка» с
запросом, см. п. 1 выше), так и самостоятельно, без запроса с вашей стороны (услуга «СМС-оценка» без
запроса).
Пример выгрузки оценок клиентов для демо-юзера на сайте sms-vote.ru (id=52):
http://sms-vote.ru/api/c1api.php?responseType=json&json= {"id":52,"job":"respList",
"current_date":"20140620105245", "date_from":"2014-04-01 00:00:00","date_to":"2014-04-30
3:59:59","secure":"655c6852dd9e7d4f4acd03954770f972"}
job
respList
responseType
New! если равно json, то результат будет возвращён в формате json. Если параметр
пропущен, результат будет возвращён в формате csv.
date_from
дата, начиная с которой надо выгрузить отчет об ответах ваших клиентов.
date_to
дата, до которой надо получить отчет об ответах ваших клиентов.
Остальные параметры см. выше.
Данные по результатам опросов возвращаются в json или csv-формате в следующем порядке:
Тел. номер
Оценка
Сотрудник
Номер заказа Дата и время Текст СМС
клиента
клиента
оценки
СМС-голосование New!
СМС-голосования можно проводить на различных мероприятиях для связи с аудиторией, проведения опросов и
конкурсов. СМС-голосования можно также проводить в режиме анкетирования для быстрого сбора и обработки
ответов участников на вопросы анкеты. См. описание «СМС-анкетирования» на sms-vote.ru
1. Выгрузка результатов голосования
Выгрузка результатов в формате json.
Пример для демо-юзера на сайте sms-vote.ru (id=52) и голосования №437:
http://sms-vote.ru/api/c1api.php?json={"id":52,"vote_id":"437","job":"vote_results",
"current_date":"20140620105245","secure":"655c6852dd9e7d4f4acd03954770f972"}
job
vote_results
vote_id
№ вашего голосования (см. в таблице голосований). Для каждого вашего нового
голосования номер увеличивается на единицу.
Также можно указать значение most_recent_active, тогда команда вернёт самое новое
(по дате запуска) из запущенных (active) голосований.
Остальные параметры см. выше.
Команда вернёт id (ваш внутренний номер) голосования, имя голосования, хэш голосования, статус
голосования (not active, active, finished, deleted), дата его запуска (если не запускалось, то нулевая), дата
окончания, вопрос голосования и варианты ответов с глобальным id каждого ответа (используется для
сортировки), кода (id) каждого ответа и кол-вом проголосовавших за этот вариант. Ответы сортируются в
том порядке, в котором они были созданы в голосовании.
Голосование можно вывести на экран, используя его хэш. Ссылка выглядит так: http://sms-vote.ru/?v=хэш
Результаты голосования можно выгрузить в html-формате. Ссылка выглядите так: http://sms-vote.ru/?x=хэш
Результаты сразу нескольких голосований можно выгрузить в виде сводной Excel-таблицы. Доступно в
таблице голосований. Если голосований с таким id нет или нет запущенных голосований, то будет
возвращена соответствующая ошибка – см. ниже.
Общее
1. Проверка вашего текущего баланса на счёте
Пример для демо-юзера на сайте sms-vote.ru (id=52):
http://sms-vote.ru/api/c1api.php?json={"id":52,"job":"balance","current_date":
"20140620105245","secure":"655c6852dd9e7d4f4acd03954770f972"}
job
balance
Остальные параметры см. выше. При недостаточном балансе СМС-сообщения отправляться не будут.
2. Ошибки
Сервер может возвращать следующие ошибки:
Error: wrong client id or secure code
Некорректный id клиента или secure-код
Error: 1C not allowed
Запрещена отправка сообщений через API.
Обратитесь по info@sms-vote.ru
Error: not enough balance
Недостаточный баланс. Пополните счёт –
обратитесь по info@sms-vote.ru
Error: too many SMS per day
Превышен лимит сообщений в сутки
Error: too many SMS per month
Превышен лимит сообщений в месяц
Error: wrong vote id or no active vote
Нет голосования с таким номером или нет
запущенного голосования
Error: wrong job
Ошибочная команда
Download