JSON интерфейс
- Передача сообщений
- Проверка состояния отправленных сообщений
- Проверка очереди статусов сообщений
- Проверка состояния счета
- Список доступных подписей отправителя
Передача сообщений (до 200 сообщений в запросе)
POST запрос на сервер, вида:
http://json.gate.optomsms.ru/send/ { "login": "api_login", "password": "api_password", "statusQueueName": "myQueue", "scheduleTime": "2009-01-01T12:30:01+00:00", "messages":[ { "clientId" : "1", "phone": "71234567890", "text": "Message text here", "sender": "MySender" }, { "clientId" : "2", "phone": "71234567891", "text": "text" }, { "clientId" : "3", "phone": "71234567892", "text": "Message text here", "sender": "MySender", "wapurl": "www.ru" } ] }
Параметр | Статус | Описание |
---|---|---|
login | Обязательно | Логин |
password | Обязательно | Пароль |
scheduleTime | Дата для отложенной отправки сообщения, в UTC (2009-01-01T12:30:01+00:00) | |
statusQueueName | Название очереди статусов отправленных сообщений, в случае, если вы хотите использовать очередь статусов отправленных сообщений. От 3 до 16 символов, буквы и цифры (например myQueue1) | |
clientId | Обязательно | Id сообщения на стороне клиента |
phone | Обязательно | Номер телефона, в формате +71234567890 |
text | Обязательно | Текст сообщения, в UTF-8 кодировке |
wapurl | Wap-push ссылка, в случае, если вы хотите передать wap-push сообщение (например wap.yousite.ru) | |
sender | Подпись отправителя (например TEST) | |
flash | Flash SMS – сообщение, которое сразу отображается на экране и не сохраняется в памяти телефона (1 – активировано) |
При успешной авторизации сервер должен вернуть json ответ вида:
{ "status": "ok", "messages":[ { "clientId" : "1", "smscId": "12345", "status": "accepted" }, { "clientId" : "2", "smscId": "12346", "status": "sender address invalid" } ] }
где сервис выдает результаты обработки сообщений:
Параметр | Описание |
---|---|
status | Статус приема пакета (ok – ошибок не обнаружено) |
clientId | Id сообщения на стороне клиента |
smscId | Id сообщения на стороне сервера |
status (в messages) | Статус отправки сообщения (подробнее о статусах) |
Проверка состояния отправленных сообщений (до 200 сообщений в запросе)
POST запрос на сервер, вида:
http://json.gate.optomsms.ru/status/ { "login": "api_login", "password": "api_password", "messages": [ { "clientId": "1", "smscId": "12345" }, { "clientId": "2", "smscId": "12346" } ] }
Параметр | Статус | Описание |
---|---|---|
login | Обязательно | Логин |
password | Обязательно | Пароль |
clientId | Обязательно | Id сообщения на стороне клиента |
smscId | Обязательно | Id сообщения на стороне сервера |
При успешной авторизации сервер должен вернуть json ответ вида:
{ "status": "ok/error", "messages":[ { "clientId" : "1", "smscId": "12345", "status": "delivered" }, { "clientId" : "2", "smscId": "12346", "status": "smsc reject" } ] }
где сервис выдает статусы сообщений:
Параметр | Описание |
---|---|
status | Статус приема пакета (ok – ошибок не обнаружено) |
clientId | Id сообщения на стороне клиента |
smscId | Id сообщения на стороне сервера |
status (в messages) | Статус отправленного сообщения (подробнее о статусах) |
Проверка очереди статусов сообщений
POST запрос на сервер, вида:
http://json.gate.optomsms.ru/statusQueue/ { "login": "api_login", "password": "api_password", "statusQueueName" : "myQueue", "statusQueueLimit" : "100" }
Параметр | Статус | Описание |
---|---|---|
login | Обязательно | Логин |
password | Обязательно | Пароль |
statusQueueName | Обязательно | Название очереди статусов сообщений. Название очереди устанавливается при передаче сообщения |
statusQueueLimit | Количество запрашиваемых статусов из очереди (по умолчанию 1, макс. 1000) |
При успешной авторизации сервер должен вернуть json ответ вида:
{ "status": "ok/error", "messages":[ { "smscId": "12345", "status": "delivered" }, { "smscId": "12346", "status": "smsc reject" } ] }
где сервис выдает статусы сообщений:
Параметр | Описание |
---|---|
status | Статус приема пакета (ok – ошибок не обнаружено) |
smscId | Id сообщения на стороне сервера |
status (в messages) | Статус отправленного сообщения (подробнее о статусах) |
Проверка состояния счета
POST запрос на сервер, вида:
http://json.gate.optomsms.ru/credits/ { "login": "api_login", "password": "api_password" }
Параметр | Статус | Описание |
---|---|---|
login | Обязательно | Логин |
password | Обязательно | Пароль |
При успешной авторизации сервер должен вернуть json ответ вида:
{ "status": "ok/error", "credits": "12345" }
где сервис выдает информацию о балансе:
Параметр | Описание |
---|---|
status | Статус приема пакета (ok – ошибок не обнаружено) |
credits | Количество доступных SMS на балансе (без учета возможного кредита) |
Список доступных подписей отправителя
POST запрос на сервер, вида:
http://json.gate.optomsms.ru/senders/ { "login": "api_login", "password": "api_password" }
Параметр | Статус | Описание |
---|---|---|
login | Обязательно | Логин |
password | Обязательно | Пароль |
При успешной авторизации сервер должен вернуть json ответ вида:
{ "status": "ok/error", "senders":[ "Sender_one", "Sender_two", "Sender_three" ] }
где сервис выдает информацию о доступных подписях:
Параметр | Описание |
---|---|
status | Статус приема пакета (ok – ошибок не обнаружено) |
senders | Список доступных подписей |