| Отправка сообщенийОтправка SMS-сообщенияДля отправки SMS необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>
Для получения стоимости SMS необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&cost=1
Описание параметров, передаваемых Серверу :
Параметр | Значение
|
---|
login | Логин Клиента.
|
---|
psw | Пароль Клиента или MD5-хеш пароля в нижнем регистре.
|
---|
phones | Номер или разделенный запятой или точкой с запятой список номеров мобильных телефонов в международном формате,
на которые отправляется сообщение. Номера могут передаваться без знака "+".
Если номер передан без знака "+", то он может быть исправлен автоматическим форматированием
и приведен к правильному международному формату. Таким образом, некоторые
ошибки при вводе номеров телефонов могут быть исправлены автоматически.
Для отключения автоисправления передайте номер со знаком "+".
Также можно отправлять сообщение на группу номеров, указав специальный код "G<номер группы>".
Сообщение будет отправлено на все номера, принадлежащие данной группе. Для e-mail сообщения передается список e-mail адресов
получателей.
|
---|
mes | Текст отправляемого сообщения. Максимальный размер – 800 символов. Сообщение при
необходимости будет разбито на несколько SMS, отправленных абоненту и оплаченных по отдельности. Размер одного
SMS – 160 символов в латинице или 70 символов в кириллице. При разбивке сообщения на несколько SMS в каждую часть
добавляется заголовок для объединения частей в одно сообщение на телефоне получателя, и максимальная длина становится
67 для кириллицы и 153 для латинских букв. В текст сообщения можно добавлять комментарии,
предназначенные для просмотра отправителем истории в личном кабинете.
|
---|
Дополнительные параметры
|
---|
id | Идентификатор сообщения. Назначается Клиентом. Служит для дальнейшей идентификации сообщения. Если не указывать, то будет назначен автоматически. Не обязательно уникален. Идентификатор представляет собой 32-битное число в диапазоне от 1 до 2147483647, либо строку длиной до 40 символов, состоящую из латинских букв, цифр и символов ".-_".
|
---|
sender | Имя отправителя, отображаемое в телефоне получателя.
Разрешены английские буквы, цифры, пробел и некоторые символы. Длина – 11 символов или 15 цифр.
Все имена регистрируются в личном кабинете. Для отключения Sender ID по умолчанию необходимо в качестве имени передать
пустую строку.
|
---|
translit | Признак того, что сообщение необходимо перевести в транслит.
0 (по умолчанию) – не переводить в транслит. 1 – перевести в транслит в виде "translit".
2 – перевести в транслит в виде "mpaHc/Ium".
|
---|
tinyurl | Автоматически сокращать ссылки в сообщениях. Позволяет заменять ссылки в тексте
сообщения на короткие для сокращения длины, а также для отслеживания количества переходов на
этой странице.
0 (по умолчанию) – оставить ссылки в тексте сообщения без изменений. 1 – сократить ссылки.
|
---|
time | Время отправки SMS-сообщения абоненту.
Форматы:
- DDMMYYhhmm или DD.MM.YY hh:mm.
- h1-h2. Задает диапазон времени в часах. Если текущее время меньше h1, то SMS-сообщение
будет отправлено абоненту при наступлении времени h1, если текущее время попадает в промежуток от h1 до h2,
то сообщение будет отправлено немедленно, в другом случае отправка будет выполнена на следующий день при
достижении времени h1. Данная функция, например, полезна для того, чтобы не допустить получение SMS-сообщений
абонентами в ночное время.
- 0ts, где ts – timestamp, время в секундах, прошедшее с 1 января 1970 года.
- +m. Задает относительное смещение времени от текущего в минутах. Символ + должен кодироваться как %2B в http-запросе.
Если time = 0 (по умолчанию), то сообщение будет отправлено немедленно.
|
---|
tz | Часовой пояс, в котором задается параметр time. Указывается относительно московского времени.
Параметр tz может быть как положительным, так и отрицательным. Если tz равен 0, то будет использован московский часовой
пояс, если же параметр tz не задан, то часовой пояс будет взят из настроек Клиента.
|
---|
period | Промежуток времени, в течение которого необходимо отправить рассылку. Представляет собой число
в диапазоне от 0.1 до 720 часов. Применяется совместно с параметром freq. Данный параметр позволяет растянуть рассылку во
времени для постепенного получения SMS-сообщений абонентами.
|
---|
freq | Интервал или частота, с которой нужно отправлять SMS-рассылку на очередную группу номеров. Количество
номеров в группе рассчитывается автоматически на основе параметров period и freq. Задается в промежутке от 1 до 1440 минут.
Без параметра period параметр freq игнорируется.
|
---|
flash | Признак Flash сообщения, отображаемого сразу на экране телефона.
0 (по умолчанию) – обычное сообщение. 1 – Flash сообщение.
|
---|
bin | Признак бинарного сообщения. 0 (по умолчанию) – обычное сообщение.
1 – бинарное сообщение. В http-запросе необходимо закодировать с помощью функции urlencode.
2 – бинарное сообщение, представленное в виде шестнадцатеричной строки (hex).
Бинарное сообщение передается вместе с UDH заголовком в начале в параметре mes, в котором первый байт задает длину заголовка.
Чтобы передать бинарное сообщение без UDH заголовка, укажите нулевой байт в начале сообщения (00 в hex).
Для возможности передачи параметров pid и dcs необходимо в конец бинарного сообщения добавить специальную комбинацию
"\n~~~\n" (перевод строки, 3 символа тильды и снова перевод строки) и затем текст "pid: значение1, dcs: значение2" с точным сохранением
пробелов.
|
---|
push | Признак wap-push сообщения, с помощью которого можно отправить интернет-ссылку на телефон. 0 (по умолчанию) – обычное сообщение.
1 – wap-push сообщение. В параметре mes необходимо передать ссылку и заголовок через перевод строки.
|
---|
hlr | Признак HLR-запроса для получения информации о номере из базы оператора без отправки реального SMS. 0 (по умолчанию) – обычное сообщение.
1 – HLR-запрос. Будет выполнен HLR-запрос для каждого номера телефона в списке. Параметр mes не используется.
|
---|
ping | Признак специального SMS, не отображаемого в телефоне, для проверки номеров на доступность в реальном времени по статусу доставки.
0 (по умолчанию) – обычное сообщение. 1 – ping-sms. Будет отправлено Ping-SMS на каждый номер телефона в списке.
Параметр mes не используется.
|
---|
mms | Признак MMS-сообщения, с помощью которого можно передавать текст (txt), изображения различных форматов (jpg, gif, png),
музыку (wav, amr, mp3, mid) и видео (mp4, 3gp). Файлы передаются в теле http-запроса.
0 (по умолчанию) – обычное сообщение. 1 – MMS-сообщение. Будет отправлено MMS на каждый номер телефона в списке.
|
---|
mail | Признак e-mail сообщения. Файлы, прикрепляемые к сообщению, передаются методом POST в теле http-запроса.
0 (по умолчанию) – обычное сообщение. 1 – e-mail сообщение.
|
---|
call | Признак голосового сообщения. При формировании голосового сообщения можно передавать как текст, так и прикреплять файлы.
Файлы, добавляемые к сообщению, должны передаваться методом POST в теле http-запроса.
0 (по умолчанию) – обычное сообщение. 1 – голосовое сообщение.
|
---|
voice | Голос, используемый для озвучивания текста (только для голосовых сообщений).
m (по умолчанию) – мужской голос. m2 – мужской альтернативный голос. w – женский голос. w2 – женский альтернативный голос 1.
w3 – женский альтернативный голос 2. w4 – женский альтернативный голос 3.
|
---|
param | Разделенный запятой список параметров для голосового сообщения в формате "param=w,i,n".
Здесь:
- w – время ожидания поднятия трубки абонентом после начала звонка в секундах. Если в течение указанного времени абонент не поднимет трубку,
то звонок уйдет на повтор с ошибкой "абонент занят". Рабочий диапазон значений параметра от 10 до 35, но можно указывать интервал от 0 до 99
(в случае, если значение меньше 10, то оно будет приведено к 10, аналогично для верхней границы).
- i – интервал повтора, то есть промежуток времени, по истечении которого произойдет повторный звонок (в секундах). Рабочий диапазон параметра
от 10 до 3600 (в случае, если значение меньше 10, то оно будет приведено к 10).
- n – общее количество попыток дозвона. Рабочий диапазон значений от 1 до 9 (0 будет приведен к 1).
При указании значения любого параметра, отличного от возможных, будут использованы значения всех параметров по умолчанию.
|
---|
subj | Тема MMS или e-mail сообщения. При отправке e-mail указание темы, текста и адреса отправителя обязательно. Для MMS обязательным
является указание темы или текста. Если не указать тему MMS, то в ее качестве будет использовано имя отправителя, переданное в запросе или
используемое по умолчанию.
|
---|
charset | Кодировка переданного сообщения, если используется отличная от кодировки по
умолчанию windows-1251. Варианты: utf-8 и koi8-r.
|
---|
cost | Признак необходимости получения стоимости рассылки.
0 (по умолчанию) – обычная отправка. 1 –
получить стоимость рассылки без реальной отправки.
2 – обычная отправка, но добавить в ответ стоимость выполненной рассылки.
3 – обычная отправка, но добавить в ответ стоимость и новый баланс Клиента.
|
---|
fmt | Формат ответа сервера об успешной отправке.
0 – (по умолчанию) в виде строки (OK - 1 SMS, ID - 1234).
1 – вернуть ответ в виде чисел: ID и количество SMS через запятую (1234,1), при cost = 2 еще стоимость через
запятую (1234,1,1.40), при cost = 3 еще новый баланс Клиента (1234,1,1.40,100.50), при cost = 1 стоимость и количество
SMS через запятую (1.40,1).
2 – ответ в xml формате.
3 – ответ в json формате.
|
---|
list | Список номеров телефонов и соответствующих им сообщений, разделенных двоеточием или точкой с запятой и
представленный в виде:
phones1:mes1
phones2:mes2
...
Строки разделяются через символ новой строки (%0A). В качестве phones можно указать несколько номеров телефонов через
запятую. Если в сообщении mes требуется передать символ новой строки, то укажите его через \n. В случае невозможности корректировки текста мультистрокового сообщения возможно включение специального режима для передачи такого типа сообщений. Для этого необходимо дополнительно передавать в запросе параметр nl, равный 1.
Параметр list позволяет выполнять множественную рассылку с разными сообщениями на несколько телефонов одним
http-запросом. Сообщениям в запросе присваивается единый идентификатор. Весь параметр должен быть закодирован с
помощью функции urlencode.
|
---|
valid | Срок "жизни" SMS-сообщения. Определяет время, в течение которого оператор будет пытаться доставить
сообщение абоненту. Диапазон от 1 до 24 часов. Также возможно передавать время в формате чч:мм в диапазоне от 00:01 до 24:00.
|
---|
maxsms | Максимальное количество SMS, на которые может разбиться длинное сообщение.
Слишком длинные сообщения будут обрезаться так, чтобы не переполнить количество SMS, требуемых
для их передачи. Этим параметром вы можете ограничить максимальную стоимость сообщений,
так как за каждое SMS снимается отдельная плата.
|
---|
imgcode | Значение буквенно-цифрового кода, введенного с "captcha" при использовании антиспам проверки.
Данный параметр должен использоваться совместно с параметром userip.
|
---|
userip | Значение IP-адреса, для которого будет действовать лимит на максимальное количество сообщений с одного IP-адреса в сутки,
установленный в настройках личного кабинета в пункте "Лимиты и ограничения".
|
---|
err | Признак необходимости добавления в ответ сервера списка ошибочных номеров.
0 (по умолчанию) – не добавлять список (обычный ответ сервера).
1 – в ответ добавляется список ошибочных номеров телефонов с соответствующими статусами.
|
---|
op | Признак необходимости добавления в ответ сервера информации по каждому номеру.
0 (по умолчанию) – не добавлять список (обычный ответ сервера).
1 – в ответ добавляется список всех номеров телефонов с соответствующими статусами, значениями mcc и mnc, стоимостью, и, в случае ошибочных номеров, кодами ошибок.
|
---|
pp | Осуществляет привязку Клиента в качестве реферала к определенному ID партнера.
При передаче данного параметра в виде "pp=<ID партнера>" Клиент с логином login становится рефералом партнера
с ID <ID партнера>. Сделать рефералом можно только нового Клиента, зарегистрированного в сервисе не более месяца назад
и имеющего не более 1000 отправленных сообщений, который еще не является рефералом другого партнера. Данный параметр
позволяет устанавливать Клиента в качестве реферала из своих сервисов и программ, где нет возможности зарегистрировать
Клиента по реферальной ссылке.
|
---|
Обязательными параметрами являются login, psw, phones и mes либо login,
psw и list.
После принятия и обработки данных Сервер возвращает Клиенту подтверждение с указанием результата обработки.
Все параметры, которые содержат специальные символы (плюс, пробел и т.д.), должны быть закодированы при помощи функции urlencode для передачи в HTTP-запросе.
Ответ сервера и коды ошибокСервер отправляет ответ в виде строки:
Если произошла ошибка, то ответ будет одним из следующих:
При fmt = 0:
- ERROR = N (описание) – для ошибок 1,2,4,5,9;
- ERROR = N (описание), ID - <id сообщения> – для ошибок 3,6,7,8.
При fmt = 1:
- 0,-N – для ошибок 1,2,4,5,9;
- <id сообщения>,-N – для ошибок 3,6,7,8.
При fmt = 2:
- Для ошибок 1,2,4,5,9:
<result>
<error>описание</error>
<error_code>N</error_code>
</result> |
- Для ошибок 3,6,7,8:
<result>
<error>описание</error>
<error_code>N</error_code>
<id>id сообщения</id>
</result> |
При fmt = 3:
- Для ошибок 1,2,4,5,9:
{
"error": "описание",
"error_code": N
} |
- Для ошибок 3,6,7,8:
{
"error": "описание",
"error_code": N,
"id": <id сообщения>
} |
N – номер ошибки, может принимать следующие значения:
Значение | Описание
|
---|
1 | Ошибка в параметрах.
|
---|
2 | Неверный логин или пароль.
|
---|
3 | Недостаточно средств на счете Клиента.
|
---|
4 | IP-адрес временно заблокирован из-за частых ошибок в запросах. Подробнее
|
---|
5 | Неверный формат даты.
|
---|
6 | Сообщение запрещено (по тексту или по имени отправителя).
|
---|
7 | Неверный формат номера телефона.
|
---|
8 | Сообщение на указанный номер не может быть доставлено.
|
---|
9 | Отправка более одного одинакового запроса на передачу SMS-сообщения
либо более пяти одинаковых запросов на получение стоимости сообщения в течение минуты.
|
---|
В случае успешной обработки запроса возвращается строка следующего вида:
- при cost = 0 и fmt = 0: OK - <n> SMS, ID - <id>
- при cost = 1 и fmt = 0: <cost> (<n> SMS)
- при cost = 2 и fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>
- при cost = 3 и fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>, BALANCE - <balance>
- при cost = 0 и fmt = 1: <id>,<n>
- при cost = 1 и fmt = 1: <cost>,<n>
- при cost = 2 и fmt = 1: <id>,<n>,<cost>
- при cost = 3 и fmt = 1: <id>,<n>,<cost>,<balance>
- при cost = 0 и fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
</result> |
- при cost = 1 и fmt = 2:
<result>
<cost>cost</cost>
<cnt>n</cnt>
</result> |
- при cost = 2 и fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
<cost>cost</cost>
</result> |
- при cost = 3 и fmt = 2:
<result>
<id>id</id>
<cnt>n</cnt>
<cost>cost</cost>
<balance>balance</balance>
</result> |
- при cost = 0 и fmt = 3:
{
"id": <id>,
"cnt": <n>
} |
- при cost = 1 и fmt = 3:
{
"cost": "<cost>",
"cnt": <n>
} |
- при cost = 2 и fmt = 3:
{
"id": <id>,
"cnt": <n>,
"cost": "<cost>"
} |
- при cost = 3 и fmt = 3:
{
"id": <id>,
"cnt": <n>,
"cost": "<cost>",
"balance": "<balance>"
} |
- при op = 1 и fmt = 0 или 1, информация добавляется в конец обычного вывода с новой строки:
<phone>,<mccmnc>,<cost>,<status>,<error>
- при op = 1 и fmt = 2, в ответ добавляется массив:
<phones>
<phone mccmnc="mccmnc" cost="cost" status="status" error="error">phone</phone>
...
</phones> |
- при op = 1 и fmt = 3, в ответ добавляется массив:
"phones": [{
"phone": "<phone>",
"mccmnc": "<mccmnc>",
"cost": "<cost>",
"status": "<status>",
"error": "<error>"
},
...
] |
Где:
<n> – это количество отправленных SMS, вычисляемое как количество SMS в сообщении, умноженное на количество
получателей.
<id> – идентификатор сообщения, переданный Клиентом или назначенный Сервером автоматически.
<cost> – стоимость рассылки.
<balance> – новый баланс Клиента.
<phone> – номер телефона.
<mccmnc> – числовой код страны абонента плюс числовой код оператора абонента.
<cost> – стоимость SMS-сообщения.
<status> – код статуса SMS-сообщения.
<error> – код ошибки в статусе.
Сервер не принимает более одного одинакового запроса на отправку SMS-сообщений в течение минуты
для защиты от ошибок и зацикливаний в программе на стороне Клиента для того, чтобы снизить нагрузку и не
расходовать средства Клиента, а также не допустить многократной отправки сообщения одному абоненту.
Сервер также блокирует отправку более 50 сообщений одному абоненту, которые были отправлены с перерывом
между сообщениями менее 60-ти секунд, для защиты от флуда и лишнего списания средств со счета Клиента,
так как многие операторы не пропускают большое количество сообщений одному абоненту за короткий промежуток времени.
Примеры отправки сообщенийПримеры:
Обычное сообщение:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello!
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123 &list=79999999999:Hello!%0A79999999999:Hello\nworld!
Flash сообщение в кодировке "utf-8" от отправителя "ivan", переведенное в транслит, которое должно быть доставлено абоненту 01.01.2012 г. в 00:00:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello%20world! &translit=1&time=0101120000&flash=1&sender=ivan &charset=utf-8
Бинарное EMS сообщение с текстом "Hello, World!", в котором слово "World" выделено курсивом и подчеркнуто:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999 &mes=050A0307056048656C6C6F2C20576F726C6421&bin=2
Бинарное WAP-push сообщение, передающее ссылку на сайт "http://wap.ru/":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999 &mes=0605040B8423F0DC0601AE02056A0045C60C037761702E72752F0001037761702E7275000101&bin=2
WAP-push сообщение в текстовом виде, передающее ссылку на сайт "http://wap.ru" с заголовком "WAP.RU":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999 &mes=http://wap.ru%0AWAP.RU&push=1 Комментарии в SMS-сообщенияхПри отправке SMS-сообщений можно добавлять в конец текста любой комментарий, уточняющий либо дополняющий SMS-сообщение для отправителя.
Данный текст не будет отправляться абонентам и влиять на стоимость SMS и доступен для просмотра и фильтрации в списке отправленных сообщений в личном кабинете.
Для добавления комментария необходимо в конце текста SMS-сообщения, предназначенного для отправки, указать специальную комбинацию "\n~~~\n"
(перевод строки, 3 символа тильды и снова перевод строки), и после этого любой текст, который будет считаться комментарием, не будет отправлен абоненту,
но отобразится в истории.
Примеры:
Отправка одного сообщения:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999%2C78888888888&mes=Hello!%0A~~~%0AComment
Отправка нескольких сообщений через параметр list:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&list=79999999999:Hello1!\n~~~\nComment1%0A78888888888:Hello2!\n~~~\nComment2 Отправка на группу номеровВ личном кабинете Клиента при создании или редактировании группы можно указать номер группы для рассылок сообщений.
Тогда при отправке сообщения вместо списка телефонов можно будет указывать короткий код в виде "G<номер группы>" или "g<номер группы>",
и сообщение будет отправлено на все номера телефонов, принадлежащие данной группе.
Примеры:
Отправка сообщения на все номера телефонов, принадлежащих группам с назначенными номерами 777 и 888:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=G777%2Cg888&mes=Hello! Отправка HLR-запросаВы можете проверять номера телефонов на доступность, отправляя специальный HLR-запрос.
В результате выполнения запроса будут получены данные о стране и операторе абонента,
о роуминговом операторе при нахождении абонента в чужой сети, а также о статусе абонента
(доступен или нет). Абоненты, владельцы проверяемых номеров, не будут получать никаких
уведомлений о выполненных проверках их номера.
Выполнение HLR-запроса по HTTP-протоколу выполняется тем же способом, что и отправка SMS-сообщения,
при этом в запросе необходимо передать дополнительный параметр hlr=1.
Для отправки HLR-запроса необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&hlr=1
Также доступны и другие параметры, использующиеся для отправки обычных SMS и описанные на данной странице.
Результат HLR-запроса может быть отправлен на URL для приема входящих сообщений и статусов,
заданный в настройках в личном кабинете, либо может считываться по запросу статуса отправленного SMS-сообщения.
Пример:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&hlr=1 Отправка MMS-сообщенияДля отправки MMS-сообщения необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&mms=1
Если при отправке планируется передача каких-либо файлов (текста, музыки, аудио, видео), то их необходимо передавать методом POST в теле
http-запроса к серверу. Максимальное количество вложений, передаваемых в запросе, равно двадцати, и суммарный размер всех вложений не должен
превышать 300 Кб. При превышении указанных лимитов оставшиеся вложения будут переданы в виде ссылок. Для MMS-сообщения указание темы или текста
является обязательным.
Примеры:
Отправка MMS-сообщения с темой "Privet" и текстом "Hello":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&subj=Privet&mms=1
Отправка MMS с темой "Holiday" и двумя фотографиями через библиотеку на основе cURL:
<?php include "smsc_api.php"; send_sms("79999999999", "", 0, 0, 0, 7, false, "subj=Holiday", array("/home/alex/1.jpg", "/home/alex/2.jpg")); ?>
Отправка e-mail сообщенияДля отправки e-mail необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&sender=<sender>&subj=<subj>&mail=1
Если при отправке планируется передача каких-либо файлов, то их необходимо передавать методом POST в теле http-запроса к серверу. Позиции в тексте,
в которые планируется вставлять файлы, необходимо обозначать специальным образом в виде "<file n>", где n - номер файла в формируемом списке
начиная с единицы. Если не указывать позиции, то соответствующие файлы будут добавляться в конец сообщения.
При создании сообщения можно вставлять в текст http-ссылки ранее загруженных файлов, узнать которые можно в личном кабинете на странице
отправки, нажав последовательно ссылки "прикрепить файл" – "Загруженные файлы". Также можно указывать локальные ссылки на загруженные файлы
на нашем сервере в виде "<file /upload/files/sms/каталог_загрузки/название_файла>". Для вложений-картинок можно устанавливать атрибуты, например,
"<file /upload/files/sms/каталог_загрузки/название_файла width=200 height=400>".
Максимальное количество вложений, передаваемых в запросе, равно 20, и размер каждого вложения не должен превышать 3 Мб.
При превышении указанных лимитов будет возвращаться ошибка с кодом 1 (неверные параметры).
При отправке каждого письма максимальный общий размер прикрепляемых вложений составляет 15 Мб, вложения,
не вмещающиеся в этот размер, будут передаваться ссылкой на наш сайт.
Для e-mail сообщений указание темы, текста и адреса отправителя обязательно.
Примеры отправки e-mail сообщенийПримеры:
Отправка e-mail на адрес "alex@mysite.com" с темой "Privet" и текстом "Hello" от отправителя "alex2@mysite2.com":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=alex%40mysite.com&mes=Hello&subj=Privet&sender=alex2%40mysite2.com&mail=1
Отправка e-mail с темой "Holiday" и двумя фотографиями через библиотеку на основе cURL:
<?php include "smsc_api.php"; send_sms("alex@mysite.com", "Hello", 0, 0, 0, 8, "alex2@mysite2.com", "subj=Holiday", array("/home/alex/1.jpg", "/home/alex/2.jpg")); ?>
Отправка e-mail с темой "Hello" и фотографией, загруженной ранее на сервер:
<?php include "smsc_api.php"; send_sms("alex@mysite.com", "Hello, this is my photo <file /upload/files/sms/123abc/photo.jpg width=200 height=400>", 0, 0, 0, 8, "alex2@mysite2.com", "subj=Hello"); ?>
Отправка голосового сообщения (звонок)Для отправки голосового сообщения необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&call=1
При формировании сообщения можно указывать как текст, так и добавлять медиа-файлы форматов wav и mp3.
Если планируется передача файлов, то их необходимо передавать методом POST в теле http-запроса к серверу. Позиции в тексте, в которые
планируется вставлять файлы, необходимо обозначать специальным образом в виде "<file n>", где n - номер файла в формируемом списке
начиная с единицы. Если не указывать позиции, то соответствующие файлы будут добавляться в конец сообщения.
При создании сообщения можно вставлять в текст http-ссылки ранее загруженных файлов, узнать которые можно в личном кабинете на странице
отправки, нажав последовательно ссылки "прикрепить файл" – "Загруженные файлы". Также можно указывать локальные ссылки на загруженные файлы
на нашем сервере в виде "<file /upload/files/sms/каталог_загрузки/название_файла>".
Так как телефонные линии не могут идеально проигрывать сложные медиа-файлы, то при формировании отправляемого сообщения передаваемые
файлы преобразуются к простому формату.
Максимальное количество вложений, передаваемых в запросе, равно четырем, и размер каждого вложения не должен превышать 3 Мб. При превышении
указанных лимитов обрабатываемые вложения будут исключаться.
Для передачи своего номера телефона в качестве имени отправителя необходимо указать его в параметре sender. Указанный номер прежде
должен быть добавлен и активирован в личном кабинете на данной странице.
При формировании запроса можно передавать специальный параметр param, в котором задаются некоторые характеристики звонка
(более подробно можно ознакомиться в описании). Также дополнительно в запросе можно передать параметр voice,
который определяет голос, используемый для озвучивания текста. Данный параметр может принимать следующие значения:
- voice = m – мужской голос.
- voice = m2 – мужской альтернативный голос.
- voice = w – женский голос.
- voice = w2 – женский альтернативный голос 1.
- voice = w3 – женский альтернативный голос 2.
- voice = w4 – женский альтернативный голос 3.
Отправка кода в телефонном номереПри необходимости отправки цифрового кода для подтверждения определенных операций с помощью телефонного номера (например, при регистрации нового пользователя, оформлении заказа, получении доступа к различным сервисам и т.п.) вместо отправки SMS-сообщения можно воспользоваться более дешевым способом передачи кода в номере телефона входящего звонка.
Чтобы передать код в телефонном номере необходимо отправить абоненту специальное голосовое сообщение (звонок) со словом code. При получении звонка абонент может его сбросить или поднять трубку. При поднятии трубки система сама сбросит звонок. Последние 6 цифр номера, с которого пришел звонок, будут являться секретным кодом, его необходимо использовать абоненту для подтверждения операции.
Также возможно использование более короткого кода из номера, указав количество цифр в инструкции для пользователей на своем сайте.
Для отправки указанного кода через API необходимо выполнить запрос на отправку голосового сообщения, получить сгенерированный код из ответа системы и сохранить его на своей стороне. Именно этот код придет абоненту в телефонном номере при звонке и потребуется для подтверждения операции.
Формат запроса и ответ Сервера:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=code&call=1
В случае успешной обработки запроса возвращается строка следующего вида (в стандартный ответ Сервера добавляется параметр code):
- при fmt = 0: OK - <n> SMS, ID - <id>, CODE - <code>
- при fmt = 1: <id>,<n>,<code>
- при fmt = 2 (xml):
<result>
<id>id</id>
<cnt>n</cnt>
<code>code</code>
</result> |
- при fmt = 3 (json):
{
"id": <id>,
"cnt": <n>,
"code": <code>
} |
При использовании данной функции нельзя передавать параметр voice, так как при его явной передаче в запросе произойдет обычное озвучивание текста сообщения.
Примеры отправки голосовых сообщенийПримеры:
Отправка голосового сообщения с текстом "Hello":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&call=1
Отправка голосового сообщения с текстом "Hello" от номера телефона "79991234567":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&call=1&sender=79991234567
Отправка голосового сообщения с текстом "Hello world", озвученным мужским голосом, с временем ожидания снятия трубки 20 секунд,
интервалом повтора 10 секунд и количеством попыток дозвона равным 3:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello%20world&call=1&
voice=m¶m=20%2C10%2C3
Отправка голосового сообщения с текстом "Hello world", озвученным женским альтернативным голосом:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello%20world&call=1&voice=w2
Отправка голосового сообщения с текстом и двумя звуковыми файлами через библиотеку на основе cURL:
<?php include "smsc_api.php"; send_sms("79999999999", "first file <file 1> and second file <file 2>", 0, 0, 0, 9, false, "", array("/home/alex/1.mp3", "/home/alex/2.wav")); ?>
Отправка viber-сообщенияДля отправки viber-сообщения необходимо вызвать методом GET или POST адрес:
http://billing.smstraf.ru/sys/send.php?login=<login>&psw=<password>&phones=<phones>&mes=<message>&viber=1
При создании сообщения можно вставлять в текст полные http-ссылки ранее загруженных файлов, узнать которые можно в личном кабинете на странице отправки, нажав последовательно "прикрепить файл" – "Загруженные файлы". Прикрепляемый файл по размеру не должен превышать 512 Кб и удовлетворять одному из следующих форматов: JPG, GIF, PNG.
Для вставки в сообщение кнопки, при нажатии на которую будет происходить открытие браузера и переход на указанный адрес, необходимо добавить в текст сообщения специальный макрос {button,url,text}, где:
<button> – название макроса.
<url> – полный http-адрес ссылки, по которой произойдет переход при нажатии кнопки.
<text> – текст кнопки. Длина текста не может превышать 10 символов для кириллицы и 20 символов для латиницы.
Система поддерживает следующие типы viber-сообщений:
- Только текст – абонент получает текстовое сообщение.
- Только картинка – абонент получает картинку.
- Текст+кнопка – абонент получает текстовое сообщение, под которым расположена кнопка. При нажатии на кнопку происходит переход по заданной ссылке.
- Текст+кнопка+картинка – абонент получает текстовое сообщение, под которым расположены картинка и кнопка. При нажатии на кнопку происходит переход по заданной ссылке.
Для настройки программного обеспечения и тестирования отправки viber-сообщений можно использовать наше общее имя отправителя "TEST"
и предопределенные шаблоны:
- Hello This is test message buttonhttpsmscruSite httpsmscru%w
- Здравствуйте Это тестовое сообщение buttonhttpsmscruСайт httpsmscru%w
- Test buttonhttpsmscruSite httpsmscru%w
- Тест buttonhttpsmscruСайт httpsmscru%w
- Hello This is test message buttonhttpsmscruSite
- Здравствуйте Это тестовое сообщение buttonhttpsmscruСайт
- Test buttonhttpsmscruSite
- Тест buttonhttpsmscruСайт
- httpsmscru%w
Как и в шаблонах для операторов здесь действуют общие правила создания сообщений для указанных шаблонов (внизу страницы раскрывающаяся вкладка "Правила регистрации шаблонов").
Примеры:
Отправка viber-сообщения с текстом "Hello":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=Hello&viber=1
Отправка viber-сообщения по одному из предопределенных шаблонов для тестирования с текстом "Test", кнопкой "{button,http://billing.smstraf.ru,Site}" и картинкой, ранее загруженной в личном кабинете и имеющей адрес "http://billing.smstraf.ru/upload/files/sms/1856f97d/6_1.jpg":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&viber=1&
mes=Test+%7Bbutton%2Chttp%3A%2F%2Fbilling.smstraf.ru%2CSite%7D+http%3A%2F%2Fbilling.smstraf.ru%2F
upload%2Ffiles%2Fsms%2F1856f97d%2F6_1.jpg Использование префиксов при отправке сообщенийДля отправки различных типов сообщений можно воспользоваться возможностью указания специальных префиксов в начале или вместо текста сообщения.
Поддерживаемые префиксы:
Название | Описание
|
---|
__CALL__: сообщение | Отправка голосового сообщения (звонка). При отправке голосового сообщения в конце текста можно указать
специальную комбинацию "\n~~~\n" (перевод строки, 3 символа тильды и снова перевод строки), после которой передать параметр param,
определяющий некоторые характеристики звонка (более подробно можно посмотреть в описании).
При формировании сообщения можно указывать как текст, так и добавлять медиа-файлы форматов wav и mp3, а также вставлять
ранее загруженные файлы. Более подробно по процеccу создания голосового сообщения можно прочитать на данной
странице.
|
---|
__PING__ | Отправка специального SMS, не отображаемого в телефоне, для проверки номеров на доступность в реальном времени
по статусу доставки.
|
---|
__HLR__ | Признак HLR-запроса для получения информации о номере из базы оператора без отправки реального SMS. Более подробно
по HLR-запросам можно ознакомиться здесь.
|
---|
Примеры:
Отправка голосового сообщения с текстом "Privet":
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=__CALL__%3A%20Privet
Отправка Ping-SMS:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=__PING__
Отправка HLR-запроса:
http://billing.smstraf.ru/sys/send.php?login=alex&psw=123&phones=79999999999&mes=__HLR__ Управление шаблонами сообщенийДля управления шаблонами сообщений необходимо вызвать методом GET или POST соответствующий адрес с указанием требуемой команды
и параметров.
Для создания шаблона:
http://billing.smstraf.ru/sys/templates.php?add=1&login=<login>&psw=<password>&name=<name>&msg=<msg>
Для изменения шаблона:
http://billing.smstraf.ru/sys/templates.php?chg=1&login=<login>&psw=<password>&id=<id>
Для удаления шаблона:
http://billing.smstraf.ru/sys/templates.php?del=1&login=<login>&psw=<password>&id=<id>
Для получения списка шаблонов:
http://billing.smstraf.ru/sys/templates.php?get=1&login=<login>&psw=<password>
Серверу передаются следующие параметры:
Параметр | Значение
|
---|
login | Логин Клиента.
|
---|
psw | Пароль Клиента или MD5-хеш пароля в нижнем регистре.
|
---|
name | Название шаблона.
|
---|
msg | Текст сообщения.
|
---|
format | Формат сообщения:
пустая строка – не задан.
sms – SMS-сообщение.
flash – Flash-SMS.
bin – Бинарное SMS.
push – Wap-push.
mms – MMS.
call – Звонок.
mail – E-mail.
whatsapp – WhatsApp.
viber – Viber.
|
---|
sender | Имя отправителя.
|
---|
fl[1] | Использовать для автоподписи.
|
---|
В случае ошибки Сервер возвращает следующую строку:
- При fmt = 0:
ERROR = N (описание)
- При fmt = 1:
0,-N
- При fmt = 2:
<result>
<error>описание</error>
<error_code>N</error_code>
</result> |
- При fmt = 3:
{
"error": "описание",
"error_code": N
} |
N – номер ошибки, может принимать следующие значения:
Значение | Описание
|
---|
1 | Ошибка в параметрах.
|
---|
2 | Неверный логин или пароль.
|
---|
3 | Запись не найдена.
|
---|
4 | IP-адрес временно заблокирован.
|
---|
5 | Ошибка сохранения или удаления.
|
---|
9 | Попытка отправки более трех одинаковых запросов на действия с шаблонами.
|
---|
В случае успешного запроса Сервер возвращает ответ в виде строки:
При создании шаблона:
- при fmt = 0: ID - <id>
- при fmt = 1: <id>
- при fmt = 2:
<template>
<id>id</id>
<template>
|
- при fmt = 3:
При изменении или удалении шаблона:
- при fmt = 0, 1: OK
- при fmt = 2:
<result>OK</result>
- при fmt = 3:
При запросе списка шаблонов сообщений:
- при fmt = 0:
id = <id>, name = <name>, format = <format>, sender = <sender>, flag = <flag>, message = <message>
... |
- при fmt = 1:
<id>,<name>,<format>,<sender>,<flag>,<message>
... |
- при fmt = 2:
<list>
<template>
<id>id</id>
<name>name</name>
<format>format</format>
<sender>sender</sender>
<flag>flag</flag>
<message>message</message>
</template>
...
</list> |
- при fmt = 3:
[{
"id": <id>,
"name": "<name>",
"format": "<format>",
"sender": "<sender>",
"flag": <flag>,
"message": "<message>"
},
...] |
Где:
<id> – идентификатор шаблона, назначенный системой автоматически.
<name> – название шаблона.
<format> – формат сообщения.
<sender> – имя отправителя.
<flag> – флаг для шаблона. Установка первого бита флага (fl[1]=1) назначает использование шаблона для автоподписи.
<message> – текст сообщения.
Сервер не принимает более трех одинаковых запросов на действия с шаблонами в течение минуты для снижения
нагрузки и защиты от ошибок и зацикливаний в программе на стороне Клиента.
Виртуальная отправка (режим тестирования)Данный режим работы позволяет протестировать отправку сообщений без реальной передачи SMS операторам.
Может быть полезен при первоначальной настройке и тестировании различного программного обеспечения и оборудования. Для
включения данного режима необходимо в личном кабинете в пункте "Настройки" в раскрывающемся блоке
"Настройки API" установить галочку "Режим тестирования (виртуальная отправка без оплаты)".
При виртуальной отправке все сообщения будут иметь конечный статус "Доставлено", но в процессе отправки сообщения будут проходить
все стадии обработки по цепочке "Ожидает отправки" – "Передано оператору" – "Доставлено". Получать статусы сообщений можно как по
запросу, так и на свой http-обработчик. Отправлять можно и одиночные сообщения и массовые рассылки. Тестировать при виртуальной отправке
возможно различные типы сообщений (SMS, бинарные сообщения, HLR, MMS, звонок). |