v. 1.0

Первоначальные сведения

Пути

http://xml.enterix.ru:8080/smsc-xml-api/SmscApiV1

Необходимо дополнительно согласовывать список разрешенных ip адресов, для
конфигурации firewall.

Методы

Запросы отправляются методом POST

Заголовки

Необходимо выставить заголовки запроса:
Content-Type: application/x-www-form-urlencoded
Content-Charset: UTF-8

Ошибки

Ответ при возникновении ошибок при разборе формата XML или в данных учетной записи
<xml_result res=»-XXXX» description=»»/>

Параметр Описание
res Код ошибки
description Описание ошибки

Коды ошибок обработки XML запросов

res (код ошибки) description (Описание ошибки) Причина ошибки
-3000 XML format error Не удалось разобрать XML формат
-3001 Unknown XML name Неизвестный запрос. Неизвестное значение атрибута “name” в тэге “xml_request”
-3002 Empty query Пустой запрос. Запрос не содержит требуемых атрибутов.
-2000 Error. Bad auth Неверный логин/пароль.
-2008 Error. No messages. В теле xml не обнаружены сообщения.

Формат запросов

XML запрос на отправку SMS

Формат запроса

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xml_request name=»sms_send»>
<xml_user lgn=»» pwd=»»/>
<sms id=»1″ destAddr=»» sourceAddr=»»>message</sms>
<sms id=»2″ destAddr=»» sourceAddr=»»>message</sms>
<sms id=»3″ destAddr=»» sourceAddr=»»>message</sms>
</xml_request>

Параметр Описание
id Внутренний идентификатор SMS в ИС Клиента. Целое число. Необходимо обеспечить уникальность msgId в рамках ИС Клиента, для каждого отправляемого сообщения этот параметр должен быть уникальным. По этому параметру отслеживаются дублирование запросов на отправку SMS.
sourceAddr Подпись отправителя. Максимальная длина — 11 символов. Разрешено только для клиентов с динамической подписью, иначе заменяется на подпись зарегистрированную на аккаунте.
destAddr Телефон получателя в международном формате. Например +7XXXXXXXXXX. К остальным номерам применяется процедура автоформатирования в международный формат
message Текст сообщения, который необходимо доставить получателю. Максимальная длина сообщения — 1217 символов.

Ответ в случае успешной обработки запроса

<xml_result xml_name=»sms_send» res=»»>
<push id=»1″ msgId=»XXXX» res=»0″ destAddr=»7XXXXXXXXXX» parts=»»/>
<push id=»2″ msgId=»XXXX» res=»0″ destAddr=»7XXXXXXXXXX» parts=»»/>
<push id=»3″ res=»» description=»»/>
</xml_result>

Параметр Описание
id Внутренний идентификатор SMS в ИС Клиента.
msgId Идентификатор SMS в системе Enterix. Длинное целое
res Код ошибки отправки конкретного SMS. «0» — SMS было отправлено успешно
destAddr Телефон получателя.
parts Количество SMS, на которое было разбито сообщение.
description Описание ошибки отправки конкретного SMS.

Коды ошибок отправки отдельных SMS

res (код ошибки) description (Описание ошибки) Причина ошибки
-2002 Error. Empty message. Израсходована установленная квота отправ­ки/получения SMS.
-2003 Error. Over quota Пустое сообщение
-2004 Error. Access number denied. Использование в качестве номера отправителя значения, не зарегистрированного для данного клиента.
-2005 Error. Wrong number format. Неверный формат номера получателя. Недопустимый символ в номере получателя. Длина номера получателя слишком мала.

Ответ в случае ошибки обработки запроса

<xml_result res=»-XXXX» description=»»/>

XML запрос для получения статуса ранее переданных сообщений

Формат запроса

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xml_request name=»sms_status» >
<xml_user lgn=»» pwd=»»/>
<sms msgId=»»/>
<sms msgId=»»/>
<sms msgId=»»/>
</xml_request>

Параметр Описание
msgId Идентификатор SMS в системе Enterix. Длинное целое

Ответ в случае успешной обработки запроса

<?xml version=»1.0″ encoding=»UTF-8″ ?>
<xml_request name=»sms_status» >
<xml_user lgn=»» pwd=»»/>
<sms msgId=»» status=»» destAddr=»7XXXXXXXXXX» deliveryDate=””
deliveryTime=”” description=””/>
<sms msgId=»» status=»» destAddr=»7XXXXXXXXXX» deliveryDate=””
deliveryTime=”” description=””/>
<sms msgId=»» status=»» destAddr=»7XXXXXXXXXX» deliveryDate=””
deliveryTime=”” description=””/>
</xml_request>

Параметр Описание
msgId Идентификатор ранее переданного SMS в системе Enterix. Длинное целое.
status Код статуса доставки.
destAddr Телефон получателя.
deliveryDate Дата доставки SMS. Строка вида «dd-mm-yyyy»
deliveryTime Время доставки SMS. Строка вида «hh:nn:ss»
description Описание статуса. Строка.

Коды статуса доставки

status

(код

статуса

доставки)

description Описание
0 SMS_STATUS_SCHEDULED Сообщение в очереди отправки
1 SMS_STATUS_ENROUTE Сообщение передано оператору
2 SMS_STATUS_DELIVERED Сообщение доставлено абоненту (финальный статус)
3 SMS_STATUS_EXPIRED Сообщение было передано оператору,
но не доставлено абоненту в отведенный
период времени (финальный статус)
4 SMS_STATUS_DELETED Сообщение удалено (финальный статус)
5 SMS STATUS UNDELIVERABL E Сообщение не доставлено (финальный статус)
6 SMS_STATUS_ACCEPTED Сообщение принято
7 SMS_STATUS_UNKNOWN Состояние сообщения не известно (финальный статус)
8 SMS_STATUS_REJECTED сообщение отклонено оператором (финальный статус)

Ответ в случае ошибки обработки запроса

<xml_result res=»-XXXX» description=»»/>