Протокол интеграции Viber

ПАКЕТНАЯ ОТПРАВКА

Примеры запросов

1. Пакетная отправка

Адрес сервера: https://gateway.api.sc/rest/Send/SendIM/ViberBulk/
  {
    "login":"testuser",
    "pass":"testpass",
    "sourceAddressIM":"TEST VIBER",
    "phones":
    {
      "1":
      {
        "type_viber":"button",
        "phone":"79121231234",
        "validityPeriod":"7200",
        "textIM":"Тестовое сообщение",
        "imageURL":" https://myimage.com ",
        "buttonURL":" https://myurl.com ",
        "buttonText":"CLICK ME",
        "sourceAddressSMS":"TESTSMS",
        "textSMS":"СМС сообщение"
      },
      "2":
      {
        "type_viber":"image",
        "phone":"79121231233",
        "validityPeriod":"7200",
        "imageURL":"https://myimage.com"
      },
      "3":
      {
        "type_viber":"text",
        "phone":"79121231232",
        "validityPeriod":"7200",
        "sourceAddressIM":"Stream Tele",
        "textIM":"Текст вайбер сообщения"
      }
    }
  }

2. Пример запроса отправки на несколько номеров

Адрес сервера: https://gateway.api.sc/rest/Send/SendIM/ViberBulk/
  {
    "login":"testuser",
    "pass":"testpass",
    "sourceAddressIM":"TEST VIBER",
    "textIM":"Тестовое сообщение",
    "type_viber":"text",
    "phones":
    {
      "1":{"phone":"79121231234"},
      "2":{"phone":"79121231233"},
      "3":{"phone":"79121231232"}
    }
  }

Описание параметров запроса

Пример ответа

  {
    "1": {"id": "3258315028721143935"},
    "2": {"id": "3258315028721143968"},
    "3": {"id": "3258315028721143968"}
  }

КАСКАДНАЯ ОТПРАВКА

Каскад – это комбинация действий, которая приводит к отправке СМС в случае недоставки сообщения по VIBER.

Примеры запросов

1. Единичная отправка Viber с кнопкой, картинкой и текстом, с использованием метода каскад

HTTP/1.1
  HOST: https://gateway.api.sc/rest/Send/SendIM/ViberOne/
  Content-Type: application/x-www-form-urlencoded
  HTTP/1.1 100 Continue
  login=testuser
  &pass=userpassword
  &sourceAddressIM=testvibername
  &textIM= Привет вайбер
  &phone= 79211234567
  &imageURL= https://my.site.com/images/image.jpg
  &buttonText= Нажми на кнопку
  &buttonURL= stream-telecom.ru
  &sourceAddressSMS= TestRusinfo 
  &textSMS=Тестовое сообщение 
  &validityPeriod= 7200

2. Пакетная отправка c использованием метода каскад

Адрес сервера:

https://gateway.api.sc/rest/Send/SendIM/ViberBulk/

  {
    "login":"testuser",
    "pass":"testpass",
    "sourceAddressIM":"TEST VIBER",
    "phones":
    {
      "1":
      {
        "type_viber":"button",
        "phone":"79121231234",
        "validityPeriod":"7200",
        "textIM":"Тестовое сообщение",
        "imageURL":" https://myimage.com ",
        "buttonURL":" https://myurl.com ",
        "buttonText":"CLICK ME",
        "sourceAddressSMS":"TESTSMS",
        "textSMS":"СМС сообщение"
      },
      "2":
      {
        "type_viber":"image",
        "phone":"79121231233",
        "validityPeriod":"7200",
        "imageURL":"https://myimage.com ",
        "sourceAddressSMS":"TESTSMS",
        "textSMS":"СМС сообщение"
      },
      "3":
      {
        "type_viber":"text",
        "phone":"79121231232",
        "validityPeriod":"7200",
        "sourceAddressIM":"Stream Tele",
        "textIM":"Текст вайбер сообщения",
        "sourceAddressSMS":"TESTSMS",
        "textSMS":"СМС сообщение"},
      }
    }
  }

3. Отправка на несколько номеров с использованием метода каскад

Адрес сервера:

https://gateway.api.sc/rest/Send/SendIM/ViberBulk/

  {
    "login":"testuser",
    "pass":"testpass",
    "sourceAddressIM":"TEST VIBER",
    "textIM":"Тестовое сообщение",
    "type_viber":"text",
    "sourceAddressSMS":"TESTSMS",
    "textSMS":"СМС сообщение"},
    "phones":
    {
      "1":{"phone":"79121231234"},
      "2":{"phone":"79121231233"},
      "3":{"phone":"79121231232"}
    }
  }

Описание параметров запроса

Пример ответа

1. В случае единичной отправки

"18516"

2. В случае пакетной отправки

  {
    "1": {"id": "3258315028721143935"},
    "2": {"id": "3258315028721143968"},
    "3": {"id": "3258315028721143968"}
  }

Описание параметров ответа

Примеры запросов

1. Пример POST-запроса: Только текст

HTTP/1.1

HOST:

Content-Type: application/x-www-form-urlencoded

HTTP/1.1 100 Continue

login=testuser

&pass=userpassword

&messageId=12345

2. Пример GET-запроса: (в одну строку)

Пример ответа (в случае отправки только Viber)

{
	"10889": {
		viber": {
			"error": 0,
			"state": "read",
			"state_error": "null",
			"state_time": "2017-04-10 11:07:55"
		}
	}
}

Пример ответа (в случае отправки каскада)

{
	"10891": {
		"viber": {
			"error": 0,
			"state": "undelivered",
			"state_error": "not-viber-user",
			"state_time": "2017-04-10 13:18:53"
		},
		"sms": {
			"state": "delivered",
			"state_time": "2017-04-10 13:19:00"
		}
	}
}

Пример ответа (в случае некорректного запроса)

{
	"1089": {
		"error": 1,
		"error_info": "No data for this messageId",
		"state": "null",
		"state_time": "null"
	}
}

Статусы viber

Статусы смс

Ошибки Viber

Список ошибок REST

ФОРМИРОВАНИЕ ДЕТАЛЬНОЙ СТАТИСТИКИ ПО РАССЫЛКАМ

Вы можете выполнить не более 4 запросов на формирование детальной статистики по рассылкам в час.

1. Запрос на получение детальной статистики по рассылкам за заданный указанный период времени по номеру телефона, статусу, отправителю и данным подлогинов

GET

https://gateway.api.sc/rest/Statistic/all_stat.php/?login=testuser&pass=testpass
    &startDateTime=2012-01-18T00:00:00&endDateTime=2012-01-18T23:59:00

POST

HTTP/1.1
  Host https://gateway.api.sc/rest/Statistic/all_stat.php
  Content-Type: application/x-www-form-urlencoded 
  HTTP/1.1 100 Continue
  login=testuser
  &pass=testpass
  &startDateTime=2012-01-18T00:00:00
  &endDateTime=2012-01-18T23:59:00

Наименование поля	Обязательное поле	Описание
login	Да	Логин от учетной записи Stream Telecom
pass	Да	Пароль для API Stream Telecom
startDateTime	Да	Дата и время начала периода, за который необходимо получить статистику, например 2012-01-18T00:00:00.
endDateTime	Да	Дата и время конца периода, за который необходимо получить статистику, например 2012-01-18T23:59:00.
state	Нет	Формирование статистики по определенному статусу сообщений. Допустимые значения: deliver, not_deliver, expired, sent (доставлено, не доставлено, просрочено, в процессе).
phone	Нет	Формирование статистики по определенному номеру абонента.
c_base	Нет	Указывает на необходимость выгрузки данных с привязкой к базе адресатов. Допустимые значения: 0, 1 (0 -по умолчанию).
sub_stat	Нет	Указывает на необходимость выгрузки данных с подлогинов. Допустимые значения: 0, 1 (0 -по умолчанию).
zip	Нет	Указывает на формат выгрузки. Допустимые значения: 0, 1 (0 – по умолчанию). 0 – файл в формате xlsx 1 – архив, содержащий файл в формате xlsx
id_smpp	Нет	Указывает на необходимость добавления в выгрузку идентификаторов сообщений. Допустимые значения: true, false (false – по умолчанию)

Ответ

HTTP/1.1 200 OK
  Cache-Control: private
  Connection: Keep-Alive
  Content-Type: application/json; charset=utf-8
  12124

Наименование поля	Описание
Возвращаемое значение	ID формируемого отчета.

В случае отправки некорректного запроса, будет возвращен код возникшей ошибки.

Текст ошибки	Описание
More than 2 reports at once are not allowed, make request later	Запрос более двух отчетов одновременно не разрешен, отправьте запрос позднее
Request per hour limit exceeded	Превышен лимит запросов в час (не более 4)
Bad Request	Некорректный запрос
Not correct format endDateTime	Некорректный формат даты конца периода
Not correct format startDateTime	Некорректный формат даты начала периода
SessionID expired	Истек срок идентификатора сессии
Not correct length originator	Некорректная длина имени отправителя
Not correct length phone	Некорректная длина номера телефона
Phone must be numeric	Номер телефона должен иметь числовой формат
EndDateTime can not be null or empty\r\nParameter name: endDateTime	Параметр endDateTime не может быть нулевым или пустым
StartDateTime can not be null or empty\r\nParameter name: startDateTime	Параметр startDateTime не может быть нулевым или пустым
Id report not found	Идентификатор отчета не найден
Report is not ready yet	Отчет не готов
File not exist	Файл не существует

2. Запрос на получение файла с отчетом

GET

https://gateway.api.sc/rest/Statistic/all_stat.php/?login=testuser&pass=testpass&id_report=12124

POST

HTTP/1.1
  Host https://gateway.api.sc/rest/Statistic/all_stat.php
  Content-Type: application/x-www-form-urlencoded
  HTTP/1.1 100 Continue
  login=testuser
  &pass=testpass
  &id_report=12124

Ответ

В зависимости от передаваемых настроек, файл детальной статистики в формате xlsx или архив, содержащий данный файл.