Руководство по взаимодействию с VIBER на основе протокола REST.
Транскрипт
1 Руководство по взаимодействию с VIBER на основе протокола REST.
3 История версий Дата изменения Версия документа Автор изменения а Скребов Н.А. Документ создан Спассков А.С. Добавлено описание получения статусов Viber Спассков А.С. Внесен максимальный и минимальный срок жизни сообщения Viber Спассков А.С. Добавлена пакетная отправка 3
4 Общие положения ВНИМАНИЕ! Для использования данного вида интеграции, Вам необходимо зарегистрироваться на серверной платформе STREAM TELECOM по адресу https://web.szk-info.ru. Варианты: 1) Регистрация в личном кабинете 2) Регистрация через менеджера компании Stream Telecom 1. Общие положения Серверная платформа Stream Telecom (далее Платформа) и клиент сервиса (далее Клиент) обмениваются HTTPS URL encoded запросами, используя форматы передач данных JSON, в соответствии с принципами REST. Действие над данными задается с помощью методов GET или POST в кодировке UTF Точка доступа Запросы Клиента должны передаваться на Платформу по URL: (ssl: https://gateway.api.sc/rest/send/sendim/viberone/) 4
6 &sourceaddressim=testvibername &textim= Привет вайбер &phone= &imageurl= https://my.site.com/images/image.jpg &buttontext= Нажми на кнопку &buttonurl= stream-telecom.ru &validityperiod= Пример POST запроса с кнопкой, картинкой и текстом, с методом каскад Каскад это комбинация действий, которая приводит к отправке СМС, в случае недоставки сообщения по VIBER. HTTP/1.1 HOST: https://gateway.api.sc/rest/send/sendim/viberone/ Content-Type: application/x-www-form-urlencoded HTTP/ Continue login=testuser &pass=userpassword &sourceaddressim=testvibername &textim= Привет вайбер &phone= &imageurl= https://my.site.com/images/image.jpg &buttontext= Нажми на кнопку &buttonurl= stream-telecom.ru &sourceaddresssms= TestRusinfo (Имя отправителя по sms(каскад)) &textsms=тестовое сообщение (Текст резервного сообщения по sms(каскад)) &validityperiod=
8 Получение статусов Viber Примеры запросов 1. POST запрос: Только текст HTTP/1.1 HOST: https://gateway.api.sc/rest/state/viber/ Content-Type: application/x-www-form-urlencoded HTTP/ Continue login=testuser &pass=userpassword &messageid= GET запроc (в одну строку) https://gateway.api.sc/rest/state/viber/?login=testuser&pass=userpassword&mess ageid=12345 Название Обязательно Тип е поле данных login Да String Логин от учетной записи Stream Telecom pass Да String Пароль от учетной записи Stream Telecom messageid Да String Id сообщения Viber (можно указывать несколько id через запятую) Пример ответа (в случае отправки только Viber) «10889»: «viber»: «error»: 0, «state»: «read», «state_error»: «null», «state_time»: " :07:55″ 8
10 Пакетная отправка Примеры запросов 1. Пакетная отправка Адрес сервера: https://gateway.api.sc/rest/send/sendim/viberbulk/ "login":"testuser", "pass":"testpass", "sourceaddressim":"test VIBER«, «phones»: «1»: "type_viber":"button«, «phone»:" ", "validityperiod":"7200″, "textim":"тестовое сообщение«, «imageurl»:" https:\/\/myimage «, „buttonurl“:» https:\/\/myurl ", "buttontext":"click ME", "sourceaddresssms":"testsms", "textsms":"sms сообщение«, «2»: "type_viber":"image«, «phone»:" ", "validityperiod":"7200″, "imageurl":"https:\/\/myimage«, «3»: "type_viber":"text«, «phone»:" ", "validityperiod":"7200″, "sourceaddressim":"stream Tele", "textim":"текст вайбер сообщения" 10
12 Название Обязательно Тип е поле данных login Да String Логин от учетной записи Stream Telecom pass Да String Пароль от учетной записи Stream Telecom sourceaddressim Да String Имя отправителя, зарегистрированное для Viber type_viber Да String Тип сообщения Viber (button текст с кнопкой и картинкой, image картинка и текст, text только картинка) textim Да String Текст отправляемого сообщения Viber (Сообщение не должно содержать более 1000 символов) phone Да Integer Номер получателя сообщения Viber imageurl* Нет String URL изображения в формате: https://my.site.com/images/image.jpg Длина URL изображения не более 1000 символов. buttontext** Нет String Наименование кнопки. (не более 30 символов) buttonurl** Нет String URL кнопки в формате: https://my.site.com/ Длина URL кнопки для перехода не более 1000 символов. sourceaddresssms Нет String Имя отправителя SMS (при наличии параметров sourceaddresssms и textsms, абоненту будет активирована каскадная отправка) textsms Нет String Текст сообщения SMS (при наличии параметров sourceaddresssms и textsms, абоненту будет активирована каскадная отправка) validityperiod Нет Integer Время ожидания доставки сообщения Viber в секундах. По умолчанию 7200 секунд. (Min=15, Max=86400) 12
