База знаний

Использование протокола НТТP (GET-запросы) для отправки и приема смс сообщений

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

Метод отправки запроса: GET

Список параметров:

Имя параметра Значение параметра
user Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X
pass Пароль пользователя
sender Подпись отправителя, строка длиной до 11 символов (текст) или до 16 символов (номер) в зависимости от типа. Параметр не может быть пустым. Имя отправителя обязательно должно быть одобрено в личном кабинете на платформе.
number Телефонный номер получателя SMS в международном формате без символа "+", строка длиной до 129 символов. Если сообщение отправляется на несколько номеров, то указывается несколько номеров через запятую (не более 10). Параметр не может быть пустым.
text Текст, передаваемый в SMS

Пример отправляемого запроса:

https://web.smsgold.ru/http2/?user=LOGIN&pass=PASSWORD&sender=SENDERNAME&number=79XXXXXXXXX&text=ТЕКСТ+ВАШЕЙ+СМС

Корректный ответ сервера при отправке сообщения:

XXXXXXXXXXX

или

XXXXXXXXXXX,XXXXXXXXXXX,XXXXXXXXXXX,...
  • XXXXXXXXXXX - уникальный идентификатор SMS в системе ESME

Проверка статуса

Метод отправки запроса: GET

Список параметров

Имя параметра Значение параметра
user Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X
pass Пароль пользователя
smsid Уникальный идентификатор, ранее переданного SMS, в системе ESME

Пример отправляемого запроса:

https://web.smsgold.ru/http2/?user=LOGIN&pass=PASSWORD&smsid=XXXXXXXXXXX

При успешной обработке HTTP-запроса сервером в ответ придет статус смс сообщения с запрошенным smsid.

Возможные статусы:

QUEUED  - сообщение находится в обработке на нашей стороне
ENROUTE - сообщение отправлено оператору
DELIVRD - сообщение успешно доставлено
EXPIRED - время жизни сообщения истекло
DELETED - сообщение удалено
UNDELIV - не удалось доставить сообщение
ACCEPTD - сообщение принято и будет отправлено оператору
UNKNOWN - состояние сообщения не определено
REJECTD - сообщение отклонено

Проверка информации о балансе

Метод отправки запроса: GET

Список параметров

Имя параметра Значение параметра
user Зарегистрированное в системе ID пользователя вида XXXXX или ХХХХХ.X
pass Пароль пользователя
action balance

Пример отправляемого запроса:

https://web.smsgold.ru/http2/?user=LOGIN&pass=PASSWORD&action=balance

При успешной обработке HTTP-запроса сервером в ответ придет баланс клиента в рублях

Ограничение на передачу специальных символов в тексте SMS

Для предотвращения ошибок при обработке HTTP-запросов и ответов, символы в тексте сообщения, которые используются как служебные в языке XML и HTML, необходимо заменять. Замена производится в запросах по таблице слева направо.

Специальный символ Замена на
" " - пробел %20 или +
"&" - амперсанд %26
"+" - плюс %2B
"!" - восклицательный знак %21
""" - кавычки %22
"#" - знак решётки %23
"$" - символ доллара %24
"%" - знак процента %25
"'" - апостроф %27
"(" - открывающая круглая скобка %28
")" - закрывающая круглая скобка %29
"*" - звёздочка %2A
"," - запятая %2C
"/" - косая черта %2F
"\" - обратная косая черта %5C
":" - двоеточие %3A
";" - точка с запятой %3B
"=" - знак равенства %3D
"?" - вопросительный знак %3F
"@" - коммерческое at %40
"[" - открывающая квадратная скобка %5B
"]" - закрывающая квадратная скобка %5D
"LF" - перевод строки %0A