Skip to content

smsgate/CascadingDoc

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits

README.md

README.md

 
 

Repository files navigation

Содержание

Руководство по взаимодействию с сервисом на основе HTTPS протокола, методом GET

Запросы необходимо отправлять в UTF-8 кодировке. Не стоит использовать URL длиной более 2,000 символов. Но этот параметр зависит от многих факторов и может различаться в большую или меньшую сторону. Одинаковые запросы можно отправлять не чаще 1 раза в 1 минуту. В случае ошибки вернется:

error: Попытка отправки более одного одинакового запроса в течение минуты

Запрос на отправку сообщения

Отправляется GET-запрос по адресу:

https://имя_хоста/sendmessage.php

Пример:

https://имя_хоста/sendmessage.php?login=ЛОГИН&password=ПАРОЛЬ&phone=ТЕЛЕФОН&send_viber=1&sender_viber=ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР&text_viber=ТЕКСТ_ВАЙБЕР&button_text=ТЕКСТ_КНОПКИ&button_url=ССЫЛКА_КНОПКИ&image_url=ИЗОБРАЖЕНИЕ&send_sms=3&sender_sms=ИМЯ_ОТПРАВИТЕЛЯ_СМС&text_sms=ТЕКСТ_СМС&validity_period_viber=60&finale_viber_read=0&send_vk=2&templateId=100&templateData={"Name":"Имя","Where":"Москва"}

Где:

  • login – Логин пользователя;
  • password – Пароль;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • phone - Номер абонента, которому адресовано сообщение. Можно несколько телефонов через запятую. Номера в международном формате, например, 79000000001 (для России), 380442589632 (для Украины);
  • send_viber – Отправлять ли VIBER сообщение. Также является порядком сортировки отправки VIBER сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VIBER сообщение;
  • sender_viber – Имя отправителя VIBER. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение;
  • text_viber – Текст VIBER сообщения. Не должен превышать более 1000 символов. Обязательный параметр;
  • button_text – Текст кнопки. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url;
  • button_url – Ссылка кнопки. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text;
  • image_url – Ссылка на изображение. Необязательный параметр. В случае добавления изображения, также необходимо наличие кнопки (button_text и button_url);
  • send_whatsapp – Отправлять ли WhatsApp сообщение. Также является порядком сортировки отправки WhatsApp сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять WhatsApp сообщение;
  • sender_whatsapp – Имя отправителя WhatsApp. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение (Либо будет подобран случайный номер, как имя отправителя);
  • text_whatsapp – Текст WhatsApp сообщения. Не должен превышать более 1000 символов. Обязательный параметр;
  • button_text_whatsapp – Текст кнопки WhatsApp. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url_whatsapp (временно недоступен);
  • button_url_whatsapp – Ссылка кнопки WhatsApp. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text (временно недоступен);
  • image_url_whatsapp – Ссылка на изображение WhatsApp. Необязательный параметр;
  • send_sms – Отправлять ли SMS. Также является порядком сортировки отправки SMS (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять SMS;
  • sender_sms - Отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
  • text_sms - Текст SMS.
  • validity_period_viber – Время жизни VIBER сообщения. За этот период, система делает попытки доставить сообщение абоненту. Если за указанный период не будет доставлено сообщение, оно профинализируется со статусом просрочено либо не доставлено. Необязательный параметр. Указывается в минутах, например "60" - что значит 1 час. Если не указано, по умолчанию будет "60";
  • finale_viber_read – Считать финальным доставленным VIBER сообщением статус "прочитано". В системе VIBER существуют статусы как доставлено и прочитано. В случае если в данном поле указали "1", то в VIBER сообщении, в котором фигурирует статус доставлено, но не прочитано, по истечению время жизни VIBER сообщения - будет попытка переотправки сообщения по другой системе (например через SMS), если в самом XML запросе фигурирует каскадная отправка (send_viber и send_sms);
  • send_vk - Отправлять ли VK сообщение. Также является порядком сортировки отправки VK сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VK сообщение. Для открытия данного направления для вас, свяжитесь с вашим менеджером;
  • templateId - Идентификатор шаблона в системе. Можете посмотреть Идентификатор шаблона в личном кабинете;
  • templateData - Значения параметров шаблона. Шаблон должен быть согласован VK. В GET запросе должен быть в виде JSON-данных. Можете использовать php функцию urlencode() для этих данных, во избежание ошибок;

В данном примере, первым будет попытка отправки VIBER сообщения, и в случае недоставки, будет попытка инициализация отправки VK сообщения, далее SMS;

В случае успешной отправки сообщения

Возвращается ID сообщения в plainText. Пример:

1000123

В случае отправки на несколько номеров возращается ID сообщения через запятую в plaintText. Пример:

1000123,10001234

В случае ошибки

В случае возникновения ошибки возращается текст ошибки в plainText.

Проверка статуса сообщения

Отправляетя GET-запрос по адресу:

https://имя_хоста/sendmessage.php

Пример:

https://имя_хоста/sendmessage.php?login=ЛОГИН&password=ПАРОЛЬ&id_message=ID_СООБЩЕНИЯ

Где:

  • login – Логин пользователя;
  • password – Пароль;
  • id_message – ID сообщения.

В случае успешного запроса

В случае успешного запроса возращается статус сообщения в plainText:

  • send - Статус сообщения не получен;
  • not_deliver - Сообщение не было доставлено.
  • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
  • deliver - Сообщение доставлено.
  • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки.

Пример:

deliver

В случае ошибки

В случае возникновения ошибки возвращается текст ошибки в plainText.

Руководство по взаимодействию с сервисом на основе JSON документов, методом POST

Общие принципы отправки

На определенный адрес сервера отправляются JSON документы (описание JSON документов, их назначение и адреса сервера приведены ниже). При этом используется POST метод.

Заголовки отправляемых данных должны содержать:

Content-Type: application/json; charset=utf-8

Кодировка JSON документов UTF-8.

Пример передачи JSON документа на php

$param = array(
	'login' => 'ЛОГИН',
	'password' => 'ПАРОЛЬ'
);
$param_json = json_encode($param);
// JSON-документ
$href = 'https://имя_хоста/sendmessagejson.php'; // адрес сервера
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json','charset=utf-8','Expect:'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $param_json);
curl_setopt($ch, CURLOPT_TIMEOUT, 600);
curl_setopt($ch, CURLOPT_URL, $href);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);
$res = curl_exec($ch);
$result = json_decode($res, true);
curl_close($ch);
print_r($result);

Отправка сообщения

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

https://имя_хоста/sendmessagejson.php

JSON-документ:

{
	"login":"login",
	"password":"password",
	"message":[
		{
			"send_viber":"1",
			"send_whatsapp":"2",
			"send_vk":"3",
			"send_sms":"4",
			"name_delivery":"НАЗВАНИЕ_РАССЫЛКИ",
			"time_send":"ВРЕМЯ_ОТПРАВКИ",
			"sender_viber":"ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР",
			"text_viber":"ТЕКСТ_ВАЙБЕР",
			"button_text":"ТЕКСТ_КНОПКИ_ВАЙБЕР",
			"button_url":"ССЫЛКА_КНОПКИ_ВАЙБЕР",
			"image_url":"ИЗОБРАЖЕНИЕ_ВАЙБЕР",
			"validity_period_viber":"ВРЕМЯ_ЖИЗНИ_ВАЙБЕР_СООБЩЕНИЯ",
			"finale_viber_read":"ФИНАЛЬНЫЙ_СТАТУС_ДОСТАВКИ_КАК_ПРОЧИТАНО",
			"sender_whatsapp":"ИМЯ_ОТПРАВИТЕЛЯ_WHATSAPP",
			"text_whatsapp":"ТЕКСТ_WHATSAPP",
			"button_text_whatsapp":"ТЕКСТ_КНОПКИ_WHATSAPP",
			"button_url_whatsapp":"ССЫЛКА_КНОПКИ_WHATSAPP",
			"image_url_whatsapp":"ИЗОБРАЖЕНИЕ_WHATSAPP",
			"validity_period_whatsapp":"ВРЕМЯ_ЖИЗНИ_WHATSAPP_СООБЩЕНИЯ",
			"sender_sms":"ИМЯ_ОТПРАВИТЕЛЯ_СМС",
			"text_sms":"ТЕКСТ_СМС",
			"templateId":"100",
			"templateData":{
				"Name":"Имя",
				"Where":"Москва"
			},
			"phones":[
				{"phone":"79801234567","client_id_message":"111"},
				{"phone":"79800000001","client_id_message":"112"}
			],
			"base":[
				{"base":"4"},
				{"base":"5"}
			],
			"stop_base":[
				{"base":"6"},
				{"base":"7"}
			]
		},
		{
			"send_viber":"1",
			"name_delivery":"НАЗВАНИЕ_РАССЫЛКИ_2",
			"sender_viber":"ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_2",
			"text_viber":"ТЕКСТ_ВАЙБЕР_2",
			"phones":[
				{"phone":"79800000002","client_id_message":"113"}
			]
		},
		{
			"name_delivery":"НАЗВАНИЕ_РАССЫЛКИ_3",
			"sender_viber":"ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_3",
			"text_viber":"ТЕКСТ_ВАЙБЕР_3",
			"phones":[
				{"phone":"79800000003"}
			]
		}
	]
}

PHP-данные:

$param = array(
	'login' => 'login',
	'password' => 'password',
	'message' => array(
		array(
			'send_viber' => '1',
			'send_whatsapp' => '2',
			'send_vk' => '3',
			'send_sms' => '4',
			'name_delivery' => 'НАЗВАНИЕ_РАССЫЛКИ',
			'time_send' => 'ВРЕМЯ_ОТПРАВКИ',
			'sender_viber' => 'ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР',
			'text_viber' => 'ТЕКСТ_ВАЙБЕР',
			'button_text' => 'ТЕКСТ_КНОПКИ_ВАЙБЕР',
			'button_url' => 'ССЫЛКА_КНОПКИ_ВАЙБЕР',
			'image_url' => 'ИЗОБРАЖЕНИЕ_ВАЙБЕР',
			'validity_period_viber' => 'ВРЕМЯ_ЖИЗНИ_ВАЙБЕР_СООБЩЕНИЯ',
			'finale_viber_read' => '1',
			'sender_whatsapp' => 'ИМЯ_ОТПРАВИТЕЛЯ_WHATSAPP',
			'text_whatsapp' => 'ТЕКСТ_WHATSAPP',
			'button_text_whatsapp' => 'ТЕКСТ_КНОПКИ_WHATSAPP',
			'button_url_whatsapp' => 'ССЫЛКА_КНОПКИ_WHATSAPP',
			'image_url_whatsapp' => 'ИЗОБРАЖЕНИЕ_WHATSAPP',
			'validity_period_whatsapp' => 'ВРЕМЯ_ЖИЗНИ_WHATSAPP_СООБЩЕНИЯ',
			'sender_sms' => 'ИМЯ_ОТПРАВИТЕЛЯ_СМС',
			'text_sms' => 'ТЕКСТ_СМС',
			'templateId' => '100',
			'templateData' => array(
				'Name' => 'Имя',
				'Where' => 'Москва'
			),
			'phones' => array(
				array('phone' => '79801234567', 'client_id_message' => '111'),
				array('phone' => '79800000001', 'client_id_message' => '112')
			),
			'base' => array(
				array('base' => '4', 'time_send' => '2016-11-09 12:40'),
				array('base' => '5')
			),
			'stop_base' => array(
				array('base' => '6'),
				array('base' => '7')
			)
		),
		array(
			'send_viber' => '1',
			'name_delivery' => 'НАЗВАНИЕ_РАССЫЛКИ_2',
			'sender_viber' => 'ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_2',
			'text_viber' => 'ТЕКСТ_ВАЙБЕР_2',
			'phones' => array(
				array('phone' => '79800000002', 'client_id_message' => '113')
			)
		),
		array(
			'name_delivery' => 'НАЗВАНИЕ_РАССЫЛКИ_3',
			'sender_viber' => 'ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_3',
			'text_viber' => 'ТЕКСТ_ВАЙБЕР_3',
			'phones' => array(
				array('phone' => '79800000003')
			)
        )
    )
);

Где:

  • login – Логин пользователя;
  • password – Пароль;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • message – Сообщения;
    • name_delivery – Название рассылки. Если поле является пустым, по умолчанию - "Шлюз";
    • time_send – Желательное время отправки сообщения, в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Например 2017-11-23 13:00. Если поле является пустым, то отправка сообщения происходит сразу;
    • send_viber – Отправлять ли VIBER сообщение. Также является порядком сортировки отправки VIBER сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VIBER сообщение;
    • sender_viber – Имя отправителя VIBER. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение;
    • text_viber – Текст VIBER сообщения. Не должен превышать более 1000 символов. Обязательный параметр. При рассылке по базе можно использовать переменные из базы, например #number#, #name#;
    • button_text – Текст кнопки. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url;
    • button_url – Ссылка кнопки. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text;
    • image_url – Ссылка на изображение. Необязательный параметр. В случае добавления изображения, также необходимо наличие кнопки (button_text и button_url);
    • validity_period_viber – Время жизни VIBER сообщения. За этот период, система делает попытки доставить сообщение абоненту. Если за указанный период не будет доставлено сообщение, оно профинализируется со статусом просрочено либо не доставлено. Необязательный параметр. Указывается в минутах, например "60" - что значит 1 час. Если не указано, по умолчанию будет "60";
    • finale_viber_read – Считать финальным доставленным VIBER сообщением статус "прочитано". В системе VIBER существуют статусы как доставлено и прочитано. В случае если в данном поле указали "1", то в VIBER сообщении, в котором фигурирует статус доставлено, но не прочитано, по истечению время жизни VIBER сообщения - будет попытка переотправки сообщения по другой системе (например через SMS), если в самом JSON запросе фигурирует каскадная отправка (send_viber и send_sms);
    • send_whatsapp – Отправлять ли WhatsApp сообщение. Также является порядком сортировки отправки WhatsApp сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять WhatsApp сообщение;
    • sender_whatsapp – Имя отправителя WhatsApp. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение (Либо будет подобран случайный номер, как имя отправителя);
    • text_whatsapp – Текст WhatsApp сообщения. Не должен превышать более 1000 символов. Обязательный параметр;
    • button_text_whatsapp – Текст кнопки WhatsApp. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url_whatsapp (временно недоступен);
    • button_url_whatsapp – Ссылка кнопки WhatsApp. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text (временно недоступен);
    • image_url_whatsapp – Ссылка на изображение WhatsApp. Необязательный параметр;
    • send_sms – Отправлять ли SMS. Также является порядком сортировки отправки SMS (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять SMS;
    • sender_sms - Отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
    • text_sms - Текст SMS. При рассылке по базе можно использовать переменные из базы, например #number#, #name#;
    • send_vk - Отправлять ли VK сообщение. Также является порядком сортировки отправки VK сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VK сообщение. Для открытия данного направления для вас, свяжитесь с вашим менеджером;
    • templateId - Идентификатор шаблона в системе. Можете посмотреть Идентификатор шаблона в личном кабинете;
    • templateData - Значения параметров шаблона. Шаблон должен быть согласован VK;
    • phones - Получатели сообщений;
      • phone – Номер абонента, которому адресовано сообщение. В международном формате, например, 79000000001 (Для России), 380442589632 (Для Украины) и т.д.;
      • client_id_message - ID сообщения на стороне клиента. Число. Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено сообщение с таким номером, то повторная отправка не производится;
    • base - База рассылки;
      • base – Идентификатор базы, можно посмотреть в ЛК. Уточните у вашего менеджера, поддерживает ли платформа возможность рассылки по базе;
      • time_send – дата и время отправки в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Если не задано, то SMS отправляется сразу же;
    • stop_base - База стоп-листа (Игнорирование номер из рассылаемых номеров). Уточните у вашего менеджера, поддерживает ли указание баз стоп-листов;
      • base – Идентификатор базы, можно посмотреть в ЛК. Уточните у вашего менеджера, поддерживает ли платформа возможность рассылки по базе.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе

JSON:

{
	"error":"текст ошибки"
}

PHP (массив, полученный через php функцию json_decode):

array ('error' => 'текст ошибки')

В случае получения правильного JSON-документа:

JSON:

{
	"message":[
		[
			{"id_message":"ID сообщения в системе для проверки статуса","client_id_message":"ID сообщения на стороне клиента","phone":"Номер телефона получателя сообщения","count_message":"Количество частей в сообщении","id_viber":"ID VIBER сообщения","id_whatsapp":"ID WhatsApp сообщения","id_sms":"ID SMS","id_vk":"ID VK сообщения"},
			{"client_id_message":"ID сообщения на стороне клиента","phone":"Номер телефона получателя сообщения","error":"Ошибка в отправке сообщения на указанный номер"},
            {"base":"4","phone":"Номер телефона получателя сообщения","error":"Ошибка в отправке сообщения на указанный номер"},
            {"base":"4","phone":"Номер телефона получателя сообщения","error":"Ошибка в отправке сообщения на указанный номер"}
		],
		[
			{"id_message":"ID сообщения в системе для проверки статуса","client_id_message":"ID сообщения на стороне клиента","phone":"Номер телефона получателя сообщения","count_message":"Количество частей в сообщении","id_viber":"ID VIBER сообщения","id_whatsapp":"ID WhatsApp сообщения","id_sms":"ID SMS","id_vk":"ID VK сообщения"}
		],
		{"error":"Текст ошибки"}
	]
}

PHP (массив, полученный через php функцию json_decode):

Array(
	[message] => Array(
		[0] => Array ( 
			[0] => Array ( [id_message] => ID сообщения в системе для проверки статуса [client_id_message] => ID сообщения на стороне клиента [phone] => Номер телефона получателя сообщения [count_message] => Количество сообщений [id_viber] => ID VIBER сообщения [id_whatsapp] => ID WhatsApp сообщения [id_sms] => ID SMS [id_vk] => ID VK сообщения ),
			[1] => Array ( [client_id_message] => ID сообщения на стороне клиента [phone] => Номер телефона получателя сообщения [error] => Ошибка в отправке сообщения на указанный номер )
            [2] => Array ( [base] => 4 [phone] => Номер телефона получателя сообщения [error] => Ошибка в отправке сообщения на указанный номер )
            [3] => Array ( [base] => 4 [phone] => Номер телефона получателя сообщения [error] => Ошибка в отправке сообщения на указанный номер )
		),
		[1] => Array ( 
			[0] => Array ( [id_message] => ID сообщения в системе для проверки статуса [client_id_message] => ID сообщения на стороне клиента [phone] => Номер телефона получателя сообщения [count_message] => Количество сообщений [id_viber] => ID VIBER сообщения [id_whatsapp] => ID WhatsApp сообщения [id_sms] => ID SMS [id_vk] => ID VK сообщения )
		)
		[2] => Array ( 
			[error] => Текст ошибки
		)
	)
)

Где:

  • message – Сообщения;
  • id_message - ID сообщения в системе для проверки статуса;
  • client_id_message - ID сообщения на стороне клиента;
  • base - База рассылки, если рассылка была по базе;
  • phone – Номер абонента, которому адресовано сообщение;
  • count_message - Количество частей сообщения. Указано количество частей сообщения в первом указанном направлении (viber, sms);
  • id_viber - ID VIBER сообщения. 0 - если не было отправлено VIBER сообщение;
  • id_whatsapp - ID WhatsApp сообщения. 0 - если не было отправлено WhatsApp сообщение;
  • id_sms - ID SMS сообщения. 0 - если не было отправлено SMS сообщение;
  • id_vk - ID VK сообщения. 0 - если не было отправлено VK сообщение;
  • error - Информация об ошибке, если в процессе отправки сообщения произошла ошибка.

Получение статуса сообщения

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

https://имя_хоста/sendmessagejson.php

JSON-документ:

{
	"login":"login",
	"password":"password",
	"state":[
		{"id_message":"111"},
		{"id_message":"112"}
	]
}

PHP-данные:

$param = array(
	'login' => 'login',
	'password' => 'password',
	'state' => array(
		array('id_message' => '111'),
		array('id_message' => '112')
	)
);

Где:

  • login – Логин пользователя;
  • password – Пароль;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • state - Статусы сообщений:
    • id_message - ID сообщения в системе.

В ответ может быть выдан один из следующих JSON-документов:

В случае возникновения ошибки в отправляемом JSON-документе

JSON:

{
	"error":"текст ошибки"
}

PHP (массив, полученный через php функцию json_decode):

array ('error' => 'текст ошибки')

В случае получения правильного JSON-документа:

JSON:

{
	"state":[
		{"id_message":"ID сообщения в системе","time_change_state":"Время последней смены состояния","state":"Общий статус сообщения","state_sms":"Статус SMS","state_viber":"Статус VIBER сообщения","state_whatsapp":"Статус WhatsApp сообщения","state_vk":"Статус VK сообщения","num_parts_sms":"Количество часте SMS сообщения","price_sms":"Цена SMS сообщение","price_viber":"Цена VIBER сообщение","price_whatsapp":"Цена WhatsApp сообщение","price_vk":"Цена VK сообщение"},
		{"id_message":"ID сообщения в системе","time_change_state":"Время последней смены состояния","state":"Общий статус сообщения","state_sms":"Статус SMS","state_viber":"Статус VIBER сообщения","state_whatsapp":"Статус WhatsApp сообщения","state_vk":"Статус VK сообщения","num_parts_sms":"Количество часте SMS сообщения","price_sms":"Цена SMS сообщение","price_viber":"Цена VIBER сообщение","price_whatsapp":"Цена WhatsApp сообщение","price_vk":"Цена VK сообщение"}
	]
}

PHP (массив, полученный через php функцию json_decode):

Array(
	[state] => Array(
		[0] => Array ( [id_message] => ID сообщения в системе [time_change_state] => Время последней смены состояния [state] => Общий статус сообщения [state_sms] => Статус SMS [state_viber] => Статус VIBER сообщения [state_whatsapp] => Статус WhatsApp сообщения [state_vk] => Статус VK сообщения [num_parts_sms] => Количество часте SMS сообщения [price_sms] => Цена SMS сообщение сообщения [price_viber] => Цена VIBER сообщение [price_whatsapp] => Цена WhatsApp сообщение [price_vk] => Цена VK сообщение ),
		[1] => Array ( [id_message] => ID сообщения в системе [time_change_state] => Время последней смены состояния [state] => Общий статус сообщения [state_sms] => Статус SMS [state_viber] => Статус VIBER сообщения [state_whatsapp] => Статус WhatsApp сообщения [state_vk] => Статус VK сообщения [num_parts_sms] => Количество часте SMS сообщения [price_sms] => Цена SMS сообщение сообщения [price_viber] => Цена VIBER сообщение [price_whatsapp] => Цена WhatsApp сообщение [price_vk] => Цена VK сообщение )
	)
)

Где:

  • id_message - ID сообщения в системе;
  • time_change_state - Время последней смены состояния, в формате: YYYY-MM-DD hh:mm:ss где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты, ss-секунды. Например 2017-11-23 13:15:25. Поле является пустым, если сообщение с указаным ID не обнаружено;
  • state – Статус сообщения, может принимать следующие значения:
    • send - В процессе работы (не профинализировано);
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
    • ДРУГОЕ - Если статус сообщения не один из указанных выше, статус означает текст ошибки например "Сообщение с таким ID не принималось";
  • state_sms - Статус SMS, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_viber - Статус VIBER сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • read - Сообщение было прочитано.
    • link - Перейдено по ссылке.
    • unsubscribe - Отписано.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_whatsapp - Статус WhatsApp сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_vk - Статус VK сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • num_parts_sms - Количество частей в SMS, в случае если было отправлено SMS;
  • price_sms - Списанные средства за SMS, в случае если было отправлено SMS;
  • price_viber - Списанные средства за VIBER сообщение, в случае если было отправлено VIBER сообщение;
  • price_whatsapp - Списанные средства за WhatsApp сообщение, в случае если было отправлено WhatsApp сообщение;
  • price_vk - Списанные средства за VK сообщение, в случае если было отправлено VK сообщение.

Руководство по взаимодействию с сервисом на основе XML документа, методом POST

Общие принципы отправки

На определенный адрес сервера отправляются XML документы (описание XML документов, их назначение и адреса сервера приведены ниже). При этом используется POST метод.

Заголовки отправляемых данных должны содержать:

Content-type: text/xml; charset=utf-8

Кодировка XML документов UTF-8. Передаваемый XML документ не должен содержать переводов строки. Переводы строк в самих данных должны быть заменены на "\n".

Пример передачи XML документа на php

$src = '<?xml version="1.0" encoding="utf-8"?>
<request>
<security>
<login value="логин" />
<password value="пароль" />
</security>
</request>';
// XML-документ
$href = 'https://server/script.php'; // адрес сервера
$ch = curl_init();
curl_setopt ($ch, CURLOPT_HTTPHEADER, array ('Content-type: text/xml','charset=utf-8','Expect:'));
curl_setopt ($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt ($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt ($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt ($ch, CURLOPT_POST, true);
curl_setopt ($ch, CURLOPT_POSTFIELDS, $src);
curl_setopt ($ch, CURLOPT_URL, $href);
$result = curl_exec($ch);
curl_close($ch);
echo $result;

Отправка сообщения

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

https://имя_хоста/xml/message.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
	<login value="логин" />
	<password value="пароль" />
</security>
<message>
	<send_viber>1</send_viber>
	<send_whatsapp>2</send_whatsapp>
	<send_vk>3</send_vk>
	<send_sms>4</send_sms>
	<name_delivery>НАЗВАНИЕ_РАССЫЛКИ</name_delivery>
	<time_send>ВРЕМЯ_ОТПРАВКИ</time_send>
	<sender_viber>ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР</sender_viber>
	<text_viber>ТЕКСТ_ВАЙБЕР</text_viber>
	<button_text>ТЕКСТ_КНОПКИ_ВАЙБЕР</button_text>
	<button_url>ССЫЛКА_КНОПКИ_ВАЙБЕР</button_url>
	<image_url>ИЗОБРАЖЕНИЕ_ВАЙБЕР</image_url>
	<validity_period_viber>ВРЕМЯ_ЖИЗНИ_ВАЙБЕР_СООБЩЕНИЯ</validity_period_viber>
	<finale_viber_read>1</finale_viber_read>
	<sender_whatsapp>ИМЯ_ОТПРАВИТЕЛЯ_WHATSAPP</sender_whatsapp>
	<text_whatsapp>ТЕКСТ_WHATSAPP</text_whatsapp>
	<button_text_whatsapp>ТЕКСТ_КНОПКИ_WHATSAPP</button_tex_whatsappt>
	<button_url_whatsapp>ССЫЛКА_КНОПКИ_WHATSAPP</button_url_whatsapp>
	<image_url_whatsapp>ИЗОБРАЖЕНИЕ_WHATSAPP</image_url_whatsapp>
	<validity_period_whatsapp>ВРЕМЯ_ЖИЗНИ_WHATSAPP_СООБЩЕНИЯ</validity_period_whatsapp>
	<sender_sms>ИМЯ_ОТПРАВИТЕЛЯ_СМС</sender_sms>
	<text_sms>ТЕКСТ_СМС</text_sms>
	<templateId>100</templateId>
	<templateData>
		<Name>Имя</Name>
		<Where>Москва</Where>
	</templateData>
	<abonent phone="79801234567" client_id_message="111" />
	<abonent phone="79800000001" client_id_message="112" />
</message>
<message>
    <send_viber>1</send_viber>
	<name_delivery>НАЗВАНИЕ_РАССЫЛКИ_2</name_delivery>
	<sender_viber>ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_2</sender_viber>
	<text_viber>ТЕКСТ_ВАЙБЕР_2</text_viber>
	<abonent phone="79800000002" client_id_message="113" />
</message>
<message>
    <name_delivery>НАЗВАНИЕ_РАССЫЛКИ_3</name_delivery>
	<sender_viber>ИМЯ_ОТПРАВИТЕЛЯ_ВАЙБЕР_3</sender_viber>
	<text_viber>ТЕКСТ_ВАЙБЕР_3</text_viber>
	<abonent phone="79800000003" />
</message>
</request>

Где:

  • login – Логин пользователя;
  • password – Пароль;
  • Вместо логина и пароля можно использовать Токен, сгенерированный в ЛК. Необходимо в заголовке запроса использовать переменную Authorization: Bearer <ТОКЕН>
  • message – Сообщения;
    • name_delivery – Название рассылки. Если поле является пустым, по умолчанию - "Шлюз";
    • time_send – Желательное время отправки сообщения, в формате: YYYY-MM-DD hh:mm где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты. Например 2017-11-23 13:00. Если поле является пустым, то отправка сообщения происходит сразу;
    • send_viber – Отправлять ли VIBER сообщение. Также является порядком сортировки отправки VIBER сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VIBER сообщение;
    • sender_viber – Имя отправителя VIBER. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение;
    • text_viber – Текст VIBER сообщения. Не должен превышать более 1000 символов. Обязательный параметр;
    • button_text – Текст кнопки. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url;
    • button_url – Ссылка кнопки. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text;
    • image_url – Ссылка на изображение. Необязательный параметр. В случае добавления изображения, также необходимо наличие кнопки (button_text и button_url);
    • validity_period_viber – Время жизни VIBER сообщения. За этот период, система делает попытки доставить сообщение абоненту. Если за указанный период не будет доставлено сообщение, оно профинализируется со статусом просрочено либо не доставлено. Необязательный параметр. Указывается в минутах, например "60" - что значит 1 час. Если не указано, по умолчанию будет "60";
    • finale_viber_read – Считать финальным доставленным VIBER сообщением статус "прочитано". В системе VIBER существуют статусы как доставлено и прочитано. В случае если в данном поле указали "1", то в VIBER сообщении, в котором фигурирует статус доставлено, но не прочитано, по истечению время жизни VIBER сообщения - будет попытка переотправки сообщения по другой системе (например через SMS), если в самом XML запросе фигурирует каскадная отправка (send_viber и send_sms);
    • send_whatsapp – Отправлять ли WhatsApp сообщение. Также является порядком сортировки отправки WhatsApp сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять WhatsApp сообщение;
    • sender_whatsapp – Имя отправителя WhatsApp. Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение (Либо будет подобран случайный номер, как имя отправителя);
    • text_whatsapp – Текст WhatsApp сообщения. Не должен превышать более 1000 символов. Обязательный параметр;
    • button_text_whatsapp – Текст кнопки WhatsApp. Не более 19 символов. Необязательный параметр. При добавлении, обязательно чтоб была указана ссылка кнопки в параметре button_url_whatsapp (временно недоступен);
    • button_url_whatsapp – Ссылка кнопки WhatsApp. Необязательный параметр. При добавлении, обязательно чтоб было указано название кнопки в параметре button_text (временно недоступен);
    • image_url_whatsapp – Ссылка на изображение WhatsApp. Необязательный параметр;
    • send_sms – Отправлять ли SMS. Также является порядком сортировки отправки SMS (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять SMS;
    • sender_sms - Отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS;
    • text_sms - Текст SMS;
    • send_vk - Отправлять ли VK сообщение. Также является порядком сортировки отправки VK сообщения (от меньшего к большему). Может принимать значение от 0 до 9, где 0 - не отправлять VK сообщение. Для открытия данного направления для вас, свяжитесь с вашим менеджером;
    • templateId - Идентификатор шаблона в системе. Можете посмотреть Идентификатор шаблона в личном кабинете;
    • templateData - Значения параметров шаблона. Шаблон должен быть согласован VK;
    • abonent - Получатели сообщений;
      • phone – Номер абонента, которому адресовано сообщение. В международном формате, например, 79000000001 (Для России), 380442589632 (Для Украины) и т.д.;
      • client_id_message - ID сообщения на стороне клиента. Число. Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено сообщение с таким номером, то повторная отправка не производится.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
	<error>текст ошибки</error>
</response>

error - Текст ошибки.

В случае получения правильного XML-документа

<?xml version="1.0" encoding="utf-8" ?>
<response>
<message>
	<information id_message="ID сообщения в системе для проверки статуса" client_id_message="ID сообщения на стороне клиента" id_sms="ID SMS" id_viber="ID VIBER сообщения" id_vk="ID VK сообщения" phone="Номер телефона получателя сообщения">Статус/сообщение об ошибке</information>
	<information client_id_message="ID сообщения на стороне клиента" phone="Номер телефона получателя сообщения">Статус/сообщение об ошибке</information>
</message>
<message>
	<information id_message="ID сообщения в системе для проверки статуса" client_id_message="ID сообщения на стороне клиента" id_sms="ID SMS" id_viber="ID VIBER сообщения" id_vk="ID VK сообщения" phone="Номер телефона получателя сообщения">Статус/сообщение об ошибке</information>
</message>
<message>
	<error>Текст ошибки</error>
</message>
</response>

Где:

  • message – Сообщения;
  • id_message - ID сообщения в системе для проверки статуса;
  • client_id_message - ID сообщения на стороне клиента;
  • phone – Номер абонента, которому адресовано сообщение;
  • count_message - Количество частей сообщения. Указано количество частей сообщения в первом указанном направлении (viber, sms);
  • id_viber - ID VIBER сообщения. 0 - если не было отправлено VIBER сообщение;
  • id_whatsapp - ID WhatsApp сообщения. 0 - если не было отправлено WhatsApp сообщение;
  • id_vk - ID VK сообщения. 0 - если не было отправлено VK сообщение;
  • id_sms - ID SMS сообщения. 0 - если не было отправлено SMS сообщение;
  • error - Информация об ошибке, если в процессе отправки сообщения произошла ошибка.

Получение статуса сообщения

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

https://имя_хоста/xml/state_message.php

XML-документ:

<?xml version="1.0" encoding="utf-8" ?>
<request>
<security>
	<login value="логин" />
	<password value="пароль" />
</security>
<state>
	<id_message>111</id_message>
	<id_message>112</id_message>
	<id_message>113</id_message>
</state>
</request>

Где

  • login - ваш логин в системе.
  • password - ваш пароль в системе.
  • id_message - ID сообщения в системе.

В ответ может быть выдан один из следующих XML-документов:

В случае возникновения ошибки в отправляемом XML-документе:

<?xml version="1.0" encoding="utf-8"?>
<response>
	<error>текст ошибки</error>
</response>

error - Текст ошибки.

В случае получения правильного XML-документа:

<?xml version="1.0" encoding="utf-8" ?>
<response>
	<state id_message="ID сообщения в системе" time_change_state="Время последней смены состояния" state_sms="Статус SMS" state_viber="Статус VIBER сообщения" state_whatsapp="Статус WhatsApp сообщения" state_vk="Статус VK сообщения" num_parts_sms="Количество часте SMS сообщения" price_sms="Цена SMS сообщение" price_viber="Цена VIBER сообщение" price_whatsapp="Цена WhatsApp сообщение" price_vk="Цена VK сообщение">Статус</state>
	<state id_message="ID сообщения в системе" time_change_state="Время последней смены состояния" state_sms="Статус SMS" state_viber="Статус VIBER сообщения" state_whatsapp="Статус WhatsApp сообщения" state_vk="Статус VK сообщения" num_parts_sms="Количество часте SMS сообщения" price_sms="Цена SMS сообщение" price_viber="Цена VIBER сообщение" price_whatsapp="Цена WhatsApp сообщение" price_vk="Цена VK сообщение">Статус</state>
	<state id_message="ID сообщения в системе" time_change_state="Время последней смены состояния" state_sms="Статус SMS" state_viber="Статус VIBER сообщения" state_whatsapp="Статус WhatsApp сообщения" state_vk="Статус VK сообщения" num_parts_sms="Количество часте SMS сообщения" price_sms="Цена SMS сообщение" price_viber="Цена VIBER сообщение" price_whatsapp="Цена WhatsApp сообщение" price_vk="Цена VK сообщение">Статус</state>
</response>

Где:

  • id_message - ID сообщения в системе;
  • time_change_state - Время последней смены состояния, в формате: YYYY-MM-DD hh:mm:ss где, YYYY-год, MM-месяц, DD-день, hh-часы, mm-минуты, ss-секунды. Например 2017-11-23 13:15:25. Поле является пустым, если сообщение с указаным ID не обнаружено;
  • Статус – Статус сообщения, может принимать следующие значения:
    • send - В процессе работы (не профинализировано);
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
    • ДРУГОЕ - Если статус сообщения не один из указанных выше, статус означает текст ошибки например "Сообщение с таким ID не принималось";
  • state_sms - Статус SMS, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_viber - Статус VIBER сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • read - Сообщение было прочитано.
    • link - Перейдено по ссылке.
    • unsubscribe - Отписано.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_whatsapp - Статус WhatsApp сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • state_vk - Статус VK сообщения, может принимать следующие значения:
    • send - Не было отправлено;
    • not_deliver - Сообщение не было доставлено.
    • expired - Абонент находился не в сети в те моменты, когда делалась попытка доставки.
    • deliver - Сообщение доставлено.
    • partly_deliver - Сообщение было отправлено, но статус так и не был получен. В этом случае для разъяснения причин отсутствия статуса необходимо связаться со службой тех. поддержки;
  • num_parts_sms - Количество частей в SMS, в случае если было отправлено SMS;
  • price_sms - Списанные средства за SMS, в случае если было отправлено SMS;
  • price_viber - Списанные средства за VIBER сообщение, в случае если было отправлено VIBER сообщение;
  • price_vk - Списанные средства за VK сообщение, в случае если было отправлено VK сообщение; price_whatsapp - Списанные средства за WhatsApp сообщение, в случае если было отправлено WhatsApp сообщение.

About

Каскадная отправка сообщений (viber, sms)

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •