JSON ИНТЕРФЕЙС

• Передача сообщений
• Проверка состояния отправленных сообщений
• Проверка очереди статусов сообщений
• Проверка состояния счета
• Список доступных подписей отправителя

Передача сообщений (до 200 сообщений в запросе)

POST запрос на сервер, вида:

https://api.iqsms.ru/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 (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", 
    "balance": [], 
    "messages": [
        {
            "status": "accepted", 
            "smscId": "12345", 
            "clientId": "1"
        }, 
        {
            "status": "sender address invalid", 
            "smscId": "12346", 
            "clientId": "2"
        }
    ]
}

где сервис выдает результаты обработки сообщений:

Параметр	Описание
status	Статус приема пакета (ok – ошибок не обнаружено)
clientId	Id сообщения на стороне клиента
smscId	Id сообщения на стороне сервера
status (в messages)	Статус отправки сообщения (подробнее о статусах)

Проверка состояния отправленных сообщений (до 200 сообщений в запросе)

POST запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/status.json

{
    "login": "login", 
    "password": "password", 
    "messages": [
        {
            "smscId": "12345", 
            "clientId": "1"
        }, 
        {
            "smscId": "12346"
        }
    ]
}

Параметр	Статус	Описание
login	Обязательно	Логин
password	Обязательно	Пароль
clientId	Обязательно	Id сообщения на стороне клиента
smscId	Обязательно	Id сообщения на стороне сервера

При успешной авторизации сервер должен вернуть json ответ вида:

{
    "status": "ok/error", 
    "messages": [
        {
            "status": "delivered", 
            "smscId": "12345", 
            "clientId": "1"
        }, 
        {
            "status": "smsc reject", 
            "smscId": "12346"
        }
    ]
}

где сервис выдает статусы сообщений:

Параметр	Описание
status	Статус приема пакета (ok – ошибок не обнаружено)
clientId	Id сообщения на стороне клиента
smscId	Id сообщения на стороне сервера
status (в messages)	Статус отправленного сообщения (подробнее о статусах)

Проверка очереди статусов сообщений (до 1000 сообщений в запросе)

POST запрос на сервер, вида:

https://api.iqsms.ru/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)	Статус отправленного сообщения (подробнее о статусах)

Проверка состояния счета

POST запрос на сервер, вида:

https://api.iqsms.ru/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 – ошибок не обнаружено)
credits	Количество доступных SMS на балансе (без учета возможного кредита)

Список доступных подписей отправителя

POST запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/senders.json

{
    "login": "api_login",
    "password": "api_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	Список доступных подписей