jsonGateDocSparm

API документация для интеграции с медицинской информационной системой qMS (версии 20.2.13) производства компании СП.АРМ, г. Санкт-Петербург (www.sparm.com).

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

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

http://clk.prontosms.ru/messages/v2/send.json

Пример POST запроса:

{
    "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"
        }
    ], 
    "login": "login", 
    "password": "password"
}

Параметр	Статус	Описание
Login	Обязательно	Логин
password	Обязательно	Пароль
scheduleTime		Дата для отложенной отправки сообщения, в UTC (2009-01-01T12:30:01+00:00)
clientId	Обязательно	Id сообщения на стороне клиента
phone	Обязательно	Номер телефона в одном из форматов: +<код страны><код города><номер телефона> <код страны><код города><номер телефона> 8<код города><номер телефона>
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 сообщения на стороне сервера
status (в messages)	Статус отправки сообщения

Возможные значения status (в messages)

Параметр	Описание
accepted	Сообщение принято сервисом
invalid mobile phone	Неверно задан номер телефона
text is empty	Отсутствует текст
sender address invalid	Неверная (незарегистрированная) подпись отправителя
invalid schedule time format	Неверный формат даты отложенной отправки сообщения
not enough credits	Баланс пуст (проверьте баланс)

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

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

Пример POST запроса:

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

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

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

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

Возможные значения status (в messages)

Параметр	Описание
queued	Сообщение находится в очереди
delivered	Сообщение доставлено
delivery error	Ошибка доставки SMS (абонент в течение времени доставки находился вне зоны действия сети или номер абонента заблокирован)
smsc submit	Сообщение доставлено в SMSC
smsc reject	Сообщение отвергнуто SMSC (номер заблокирован или не существует)
incorrect id	Неверный идентификатор сообщения