Отправка сообщения
Спецификации для отправки сообщения: JSON, XML, HTTP GET
Метод отправки POST
Кодировка XML-документов: UTF-8
Обязательный заголовок: Content-type: text/xml; charset=utf-8;
Адрес для запроса: https://my3.webcom.mobi/xml
Примеры
Пример отправки SMS сообщения Пример отправки Viber сообщения Пример отправки Каскадного сообщения
Параметры запроса на отправку сообщения
Параметр | Тип | Описание |
---|---|---|
request .security .login [value]* | String | Ваш логин в системе |
request .security .password [value]* | String | Ваш пароль в системе |
request .security .token [value]* | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |
request .message [type_send_1]* | String | Тип отправляемого сообщения
|
request .message [type_send_2] | String | Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено по первому типу направления request.message[type_send_1], применяется для каскадной отправки
|
request .message [type] | String | Тип сообщения:
|
request .message .sender* | String | Отправитель SMS, HLR, FlashCall сообщения !Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение |
request .message .text* | String | Текст SMS, HLR, FlashCall сообщения |
request .message .abonent [phone]* | Int | Номер абонента, которому адресовано сообщение |
request .message .abonent [number_sms] | Int | Номер сообщения в пределах отправляемого XML документа |
request .message .abonent [client_id_sms] | Int | Число присваиваемое клиентом !Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS |
request .message .abonent [time_send] | date | Дата и время отправки в формате: YYYY-MM-DD HH:MM где, YYYY-год, MM-месяц, DD-день, HH-часы, MM-минуты !Если не задано, то сообщение имеет максимальный срок жизни (один день) |
request .message .abonent [validity_period] | date | Дата и время, после которых не будут делаться попытки доставить SMS в формате: YYYY-MM-DD HH:MM:SS где, YYYY - год, MM - месяц, DD - день, HH - часы, MM - минуты SS - секунды !Если не задано, то SMS имеет максимальный срок жизни (один день) |
request .message .abonent [validity_period_viber] | date | Дата и время, после которых не будут делаться попытки доставить Viber в формате: YYYY-MM-DD HH:MM:SS где, YYYY - год, MM - месяц, DD - день, HH - часы, MM - минуты SS - секунды !Если не задано, то Viber имеет максимальный срок жизни (один день) |
request .message .sender_viber | String | Отправитель Viber сообщения |
request .message .text_viber | String | Текст Viber сообщения |
request .message .button_viber | String | Текст кнопки Viber сообщения |
request .message .action_viber | String | Ссылка для кнопки Viber сообщения |
request .message .image_viber | String | Адрес картинки для Viber сообщения |
*- обязательный параметр
В случае получения правильного XML-документа
Параметр | Тип | Описание |
---|---|---|
response .information [number_sms] | Int | Номер сообщения, указанный при отправке XML документа |
response .information [id_sms] | String | Номер SMS сообщения. Используется для проверки статуса SMS. !Если в процессе отправки SMS произошла ошибка, то id_sms не передается |
response .information [parts] | Int | Количество частей SMS |
response .information | String | Статус сообщения («send»), если была отправлена, или сообщение об ошибке, если в процессе отправки произошла ошибка:
|
В случае возникновения ошибки в отправленном XML-документе
Параметр | Тип | Описание |
---|---|---|
response .error | String | Текст ошибки может принимать следующие значения:
|
Пример XML-документа для отправки SMS сообщения
Пример XML-документа для отправки Viber сообщения
Пример XML-документа для отправки Каскадного сообщения
Last updated