Использование протокола НТТP для отправки и приема сообщений ВКонтакте и Одноклассники
Все запросы отправляются на адрес: https://web.smsgold.ru/http2/
Отправка сообщения
Метод отправки запроса: POST Content-Type: application/x-www-form-urlencodedСписок обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| action | sendvk |
| number | Телефонный номер получателя сообщения в международном формате без символа "+". |
| vk_template_name | Имя шаблона, зарегистрированного ранее. Приходит при создании шаблона в письме с подтверждением от ВК ОК. Также можно получить при просмотре списка шаблонов. |
| vk_service | Присылается с первым одобренным шаблоном для подключаемой группы на указанный при запросе шаблона e-mail. |
Список необязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| vk_template_data(json_string) | Передача переменных из шаблона {"var_name1":"value","var_name2":"value"}(Если в шаблоне используются переменные, то данный параметр обязателен). |
| vk_routes | Маршрут отправки (vk - значение по умолчанию ВКонтакте, ok - Одноклассники, vk,ok - оба, т.е. доставка производится до первого получения уведомления на физическое устройство. При указании нескольких каналов доставки в итоге использован и тарифицирован будет только один из каналов.) |
| vk_delivery_policy | (any, mobile_device_required, verified_phone_number) |
| vk_ttl | Время жизни сообщения в секундах (от 60 до 24*60*60). |
| vk_type | S - режим “каскад”, отправка sms если сообщение ВК ОК не доставлено/прочитано. |
| sender | Имя отправителя для sms (будет использовано имя отправителя по умолчанию в случае если параметр пустой). |
| sms_text | Текст для sms если сообщение ВК ОК не доставлено/прочитано. |
| vk_read_ttl | Принимает значения от 0 сек. (не использовать каскад по непрочтению) до 24*60*60 сек. Работает по принципу: если сообщение не было прочитано в течении установленного количества секунд - осуществляется отправка sms, даже если сообщение было доставлено. Денежные средства за отправку сообщения ВК ОК не возвращаются, а в отчете появляется еще одно сообщение sms, т.е обновления старого объекта не происходит.Работает только если [vk_type]=S |
Добавление шаблона
Метод отправки запроса: POST Content-Type: application/x-www-form-urlencodedСписок обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| action | add_vk_template |
| vk_template_name | Имя шаблона, допустимые символы: A-Za-z0-9_ |
| notificationEmail | Электронный адрес на который будут приходить извещения о активировании/удалении шаблонов |
| vkGroupUrl|okGroupUrl | URL групп VK и OK. Обязательно указать хотя бы один параметр, можно указывать оба. |
| template|vkTemplate|okTemplate | Текстовый шаблон (общий или отдельный для групп VK и OK). В именах переменных допускаются следующие символы: A-Za-z0-9_Пример шаблона: Уважаемый #username# вам предоставляется скидка в размере #percent#% на покупку #goods# |
Список необязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| service | Идентификатор клиента и его продукта\проекта. Для новой группы (первый шаблон) этот параметр может быть пустым. Название придет в ответе о подтверждении вашего шаблона в письме на указанный email |
| attachments[filename.ext] | BASE_64_BODY_OF_IMAGE |
Редактирование шаблона
Метод отправки запроса: POST Content-Type: application/x-www-form-urlencodedСписок обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| action | update_vk_template |
| vk_template_name | Имя шаблона, допустимые символы: A-Za-z0-9_ |
| notificationEmail | Электронный адрес на который будут приходить извещения о активировании/удалении шаблонов |
| vkGroupUrl|okGroupUrl | URL групп VK и OK. Обязательно указать хотя бы один параметр, можно указывать оба. |
| template|vkTemplate|okTemplate | Текстовый шаблон (общий или отдельный для групп VK и OK). В именах переменных допускаются следующие символы: A-Za-z0-9_Пример шаблона: Уважаемый #username# вам предоставляется скидка в размере #percent#% на покупку #goods# |
| service | Идентификатор клиента и его продукта\проекта. Для новой группы (первый шаблон) этот параметр может быть пустым. Название придет в ответе о подтверждении вашего шаблона в письме на указанный email |
Список необязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| new_vk_template_name | |
| drop_attachments | |
| attachments[filename.ext] | BASE_64_BODY_OF_IMAGE |
Просмотр списка шаблонов
Метод отправки запроса: GETСписок обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| action | get_vk_templates |
Удаление шаблона
Метод отправки запроса: POST Content-Type: application/x-www-form-urlencodedСписок обязательных параметров:
| Имя параметра | Значение параметра |
|---|---|
| user | Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X |
| pass | Пароль пользователя. |
| action | delete_vk_template |
| vk_template_name | Имя шаблона, зарегистрированного ранее. Приходит при создании шаблона в письме с подтверждением от ВК ОК. Также можно получить при просмотре списка шаблонов. |