Передача сообщения (до 200 сообщений в запросе)Проверка состояния отправленных сообщений (до 200 сообщений в запросе)Проверка очереди статусов сообщений (до 1000 сообщений в запросе)Проверка состояния счетаСписок доступных подписей отправителяПроверка активной версии API
Передача сообщения (до 200 сообщений в запросе)
POST запрос
http://api.smsbliss.net/messages/v2/send.json
- {
- "scheduleTime":"2008-07-12T14:30:01Z",
- "messages":[
- {
- "phone":"71234567890",
- "sender":"MySender",
- "clientId":"1",
- "text":"Message text here"
- },
- {
- "phone":"71234567891",
- "clientId":"2",
- "text":"text"
- },
- {
- "phone":"71234567892",
- "sender":"MySender",
- "clientId":"3",
- "text":"Message text here"
- }
- ],
- "statusQueueName":"myQueue",
- "showBillingDetails":true,
- "login":"login",
- "password":"password"
- }
Параметр | | Описание |
---|
login | ✔ | Логин
|
password | ✔ | Пароль
|
scheduleTime | | Дата для отложенной отправки сообщения, в UTC (2008-07-12T14:30:01Z)
|
statusQueueName | | Название очереди статусов отправленных сообщений,
в случае, если вы хотите использовать очередь статусов отправленных
сообщений. От 3 до 16 символов, буквы и цифры (например myQueue1)
|
showBillingDetails | | Включение в ответ биллинговых данных: баланса, количества SMS в сообщении, стоимость сообщения
|
clientId | ✔ | Id сообщения на стороне клиента (A-Z 0-9, макс. 72 симв.)
|
phone | ✔ | Номер телефона, в формате +71234567890
|
text | ✔ | Текст сообщения, в UTF-8 кодировке
|
sender | | Подпись отправителя (например TEST)
|
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok",
- "balance":[],
- "messages":[
- {
- "status":"accepted",
- "smscId":"12345",
- "clientId":"1"
- },
- {
- "status":"sender address invalid",
- "smscId":"12346",
- "clientId":"2"
- }
- ]
- }
где сервис выдает результаты обработки сообщений
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
clientId | Id сообщения на стороне клиента
|
smscId | Id сообщения на стороне сервера (A-F 0-9, макс. 72 симв.)
|
status (в messages) | Статус отправки сообщения (подробнее о статусах в описании REST интерфейса)
|
smsCount | Количество SMS в сообщении
|
msgCost | Стоимость сообщения (тариф умноженный на количество SMS). Отображается, если клиент использует рублевый баланс
|
balance | Остатки средств на балансе, после отправки сообщений
|
Проверка состояния отправленных сообщений (до 200 сообщений в запросе)
POST запрос
http://api.smsbliss.net/messages/v2/status.json
- {
- "login":"login",
- "password":"password",
- "messages":[
- {
- "smscId":"12345",
- "clientId":"1"
- },
- {
- "smscId":"12346"
- }
- ]
- }
Параметр | | Описание |
---|
login | ✔ | Логин
|
password | ✔ | Пароль
|
smscId | ✔ | Id сообщения на стороне сервера
|
clientId | | Id сообщения на стороне клиента
|
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok/error",
- "messages":[
- {
- "status":"delivered",
- "smscId":"12345",
- "clientId":"1"
- },
- {
- "status":"smsc reject",
- "smscId":"12346"
- }
- ]
- }
где сервис выдает статусы сообщений
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
smscId | Id сообщения на стороне сервера
|
clientId | Id сообщения на стороне клиента (если было указано)
|
status (в messages) | Статус отправленного сообщения (подробнее о статусах в описании REST интерфейса)
|
Проверка очереди статусов сообщений (до 1000 сообщений в запросе)
POST запрос
http://api.smsbliss.net/messages/v2/statusQueue.json
- {
- "login":"login",
- "password":"password",
- "statusQueueLimit":"100",
- "statusQueueName":"myQueue"
- }
Параметр | | Описание |
---|
login | ✔ | Логин
|
password | ✔ | Пароль
|
statusQueueName | ✔ | Название очереди статусов сообщений. Название очереди устанавливается при передаче сообщения |
statusQueueLimit | ✔ | Количество запрашиваемых статусов из очереди (по умолчанию 1, макс. 1000)
|
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok/error",
- "messages":[
- {
- "status":"delivered",
- "smscId":"12345"
- },
- {
- "status":"smsc reject",
- "smscId":"12346"
- }
- ]
- }
где сервис выдает статусы сообщений
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
smscId | Id сообщения на стороне сервера
|
status (в messages) | Статус отправленного сообщения (подробнее о статусах в описании REST интерфейса)
|
Проверка состояния счета
POST запрос
http://api.smsbliss.net/messages/v2/balance.json
- {
- "login":"login",
- "password":"password"
- }
Параметр | | Описание |
---|
login | ✔ | Логин
|
password | ✔ | Пароль
|
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok/error",
- "balance":[
- {
- "credit":0.0,
- "balance":"0.00",
- "type":"RUB"
- },
- {
- "credit":1000000,
- "balance":-508784,
- "type":"SMS"
- }
- ]
- }
где сервис выдает информацию о балансах клиента: типе баланса, количестве и возможном кредите (возможности использовать сервис при отрицательном балансе)
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
type | Тип баланса: RUB, SMS
|
balance | Количество средств на балансе
|
credit | Кредит (возможность использовать сервис при отрицательном балансе)
|
Список доступных подписей отправителя
POST запрос
http://api.smsbliss.net/messages/v2/senders.json
- {
- "login":"login",
- "password":"password"
- }
Параметр | | Описание |
---|
login | ✔ | Логин
|
password | ✔ | Пароль
|
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok/error",
- "senders":[
- {
- "status":"active",
- "info":"",
- "name":"MyBrand"
- },
- {
- "status":"pending",
- "info":"",
- "name":"3132018"
- },
- {
- "status":"blocked",
- "info":"bad name",
- "name":"MegaFon"
- },
- {
- "status":"default",
- "info":"",
- "name":"TEST"
- }
- ]
- }
где сервис выдает информацию о подписях отправителя
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
senders | Список доступных подписей
|
active | Подпись активирована и готова к использованию
|
new | Новая подпись
|
pending | Подпись в процессе активации
|
blocked | Подпись заблокирована
|
default | Подпись по умолчанию, готова к использованию
|
Проверка активной версии API
POST запрос
http://api.smsbliss.net/messages/v2/version.json/
- {
- "login":"login",
- "password":"password"
- }
При успешной авторизации сервер должен вернуть json ответ вида
- {
- "status":"ok/error",
- "version":2
- }
Параметр/значение | Описание |
---|
status | Статус приема пакета (ok – ошибок не обнаружено)
|
version | Номер активной версии API
|