УТВЕРЖДАЮ Заместитель директора Федеральной службы судебных приставов – заместитель главного судебного пристава Российской Федерации ________/ «____» ___________ 2013 |
ТРЕБОВАНИЯ
к программному интерфейсу оператора рассылки СМС-сообщений
версия 4.0
2013
1. Общие положения
Настоящие требования предъявляются к автоматизированной системе оператора рассылки СМС-сообщений при интеграции с подсистемой межведомственного взаимодействия АИС ФССП России для организации оповещения должников по исполнительным производствам посредством СМС-сообщения о возбуждении исполнительного производства.
2. Требования к подключению
Канал передачи данных между оператором рассылки СМС-сообщений и ФССП России защищается посредством сертифицированного ФСБ России средства криптографической защиты информации (криптошлюза) «VipNet-координатор» (KC3). Оператором рассылки СМС-сообщений должно быть предоставлено необходимое оборудование (криптошлюз). Подключение оборудования производится совместно оператором рассылки СМС-сообщений и ФССП России.
3. Электронный сервис оператора для приема СМС сообщений
3.1. Оператором рассылки СМС-сообщений должен быть реализован электронный сервис для приема СМС сообщений от ФССП России. Интерфейс электронного сервиса должен обеспечивать передачу до 1000 сообщений в рамках одного запроса.
3.2. Интерфейс должен поддерживать ответ SMSIDItem на первичный запрос передачи SMS сообщения с следующим составом набора/массива идентификаторов: ID, packet_id, ResultCode, ResultMessage, Status, PartCount, InternalKey, ipNumber, Recipien.
a. Возможные результаты работы сервиса (ResultCode):
i. 0 – Успешно.
ii. 1 - Отказ приёма SMS (не фатальная ошибка).
iii. 10 - Неверно указан номер телефона / формат номера (фатальная ошибка).
iv. 11 - Неверно указан номер телефона / код региона (фатальная ошибка).
b. Возможные статусы (Status) SMS сообщения:
i. 0 - Сообщение не принято.
ii. 1 - Сообщение принято шлюзом и поставлено в очередь на отправку.
iii. 2 - Сообщение было передано в сотовую сеть.
iv. 3 - Сообщение доставлено / получено адресатом.
v. 4 - Сообщение не доставлено.
vi. 5 - Сообщение было отклонено в связи с истечением срока жизни / не доставлено.
vii. 6 - Сообщение было отклонено в связи с истечением максимального количества возможных попыток доставки / не доставлено.
3.3. Интерфейс электронного сервиса должен обеспечивать следующий wsdl:
<?xml version="1.0" encoding="UTF-8"?> <definitions xmlns="http://schemas. xmlsoap. org/wsdl/" xmlns:tns="http://*****/wssms. u" xmlns:soap="http://schemas. xmlsoap. org/wsdl/soap/" xmlns:xsd="http://www. w3.org/2001/XMLSchema" name="WSSMS" targetNamespace="http://*****/wssms. u"> <types> <xsd:schema targetNamespace="http://*****/wssms. u"> <xsd:element name="smsSendPacket"> <xsd:complexType> <xsd:sequence> <xsd:element name="inSMSPaket" type="tns:smsSendPacketType"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:element name="smsSendPacketResponse"> <xsd:complexType> <xsd:sequence> <xsd:element name="return" type="tns:smsSendPacketResponse"/> </xsd:sequence> </xsd:complexType> </xsd:element> <xsd:complexType name="ArrayOfSMSItemType"> <xsd:sequence> <xsd:element name="item" type="tns:SMSItemIn" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="packet_id" type="xsd:long" use="required"> <xsd:annotation> <xsd:documentation>Идентификатор пакета АИС ФССП России</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> <xsd:complexType name="SMSItemIn"> <xsd:sequence> <xsd:element name="InternalKey" type="xsd:long"> <xsd:annotation> <xsd:documentation>Идентификатор АИС ФССП России</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ipNumber" type="xsd:string"> <xsd:annotation> <xsd:documentation>Номер исполнительно производства</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Recipient" type="xsd:string"> <xsd:annotation> <xsd:documentation>Получатель СМС уведомления</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Message" type="xsd:string"> <xsd:annotation> <xsd:documentation>Текст СМС уведомления</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="smsSendPacketType"> <xsd:sequence> <xsd:element name="Driver" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation>Служебное поле</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="From" type="xsd:string"> <xsd:annotation> <xsd:documentation>Наименование отправителя СМС</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="maxRetries" type="xsd:int"> <xsd:annotation> <xsd:documentation>Количество попыток отправки СМС</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="maxInterval" type="xsd:int"> <xsd:annotation> <xsd:documentation>Время между попытками отправки SMS в секундах</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="maxTTL" type="xsd:int"> <xsd:annotation> <xsd:documentation>Время жизни СМС в секундах</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="PacketSMS" type="tns:ArrayOfSMSItemType" maxOccurs="unbounded"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="ArrayOfSMSIDItemType"> <xsd:sequence> <xsd:element name="item" type="tns:SMSItemOut" maxOccurs="unbounded"/> </xsd:sequence> <xsd:attribute name="packet_id" type="xsd:long" use="required"> <xsd:annotation> <xsd:documentation>Идентификатор пакета АИС ФССП России</xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:complexType> <xsd:complexType name="SMSItemOut"> <xsd:sequence> <xsd:element name="ID" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation>Идентификатор сервиса СМС шлюза</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ResultCode" type="tns:ResultCodeType"> <xsd:annotation> <xsd:documentation>Результат обработки СМС уведомления</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ResultMessage" type="xsd:string" minOccurs="0"> <xsd:annotation> <xsd:documentation>Описание результата работы сервиса СМС Шлюза</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Status" type="tns:ResultMessageType"> <xsd:annotation> <xsd:documentation>Статус СМС уведомления</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="PartCount" type="xsd:int" minOccurs="0"> <xsd:annotation> <xsd:documentation>Количество сформированных СМС</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="InternalKey" type="xsd:long"> <xsd:annotation> <xsd:documentation>Идентификатор АИС ФССП России</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="ipNumber" type="xsd:string"> <xsd:annotation> <xsd:documentation>Номер исполнительного производства</xsd:documentation> </xsd:annotation> </xsd:element> <xsd:element name="Recipient" type="xsd:string"> <xsd:annotation> <xsd:documentation>Получатель СМС уведомления</xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> </xsd:complexType> <xsd:complexType name="smsSendPacketResponse"> <xsd:all> <xsd:element name="PacketSMSID" type="tns:ArrayOfSMSIDItemType" nillable="true"/> </xsd:all> </xsd:complexType> <xsd:simpleType name="ResultCodeType"> <xsd:annotation> <xsd:documentation>Результат обработки СМС уведомления</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:enumeration value="0"> <xsd:annotation> <xsd:documentation>Успешно</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="1"> <xsd:annotation> <xsd:documentation>Отказ приема SMS</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="10"> <xsd:annotation> <xsd:documentation>Неверно указан номер телефона / формат номера</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="11"> <xsd:annotation> <xsd:documentation>Неверно указан номер телефона / код региона</xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> <xsd:simpleType name="ResultMessageType"> <xsd:annotation> <xsd:documentation>Статусы СМС уведомления</xsd:documentation> </xsd:annotation> <xsd:restriction base="xsd:string"> <xsd:enumeration value="0"> <xsd:annotation> <xsd:documentation>Сообщение не принято</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="1"> <xsd:annotation> <xsd:documentation>Сообщение принято шлюзом и поставлено в очередь на отправку</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="2"> <xsd:annotation> <xsd:documentation>Сообщение было передано в сотовую сеть</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="3"> <xsd:annotation> <xsd:documentation>Сообщение доставлено / получено адресатом</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="4"> <xsd:annotation> <xsd:documentation>Сообщение не доставлено</xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="5"> <xsd:annotation> <xsd:documentation>Сообщение было отклонено в связи с истечением срока жизни / не доставлено </xsd:documentation> </xsd:annotation> </xsd:enumeration> <xsd:enumeration value="6"> <xsd:annotation> <xsd:documentation>Сообщение было отклонено в связи с истечением максимального количества возможных попыток доставки / не доставлено </xsd:documentation> </xsd:annotation> </xsd:enumeration> </xsd:restriction> </xsd:simpleType> </xsd:schema> </types> <message name="smsSendPacket"> <part name="inputmsg" element="tns:smsSendPacket"/> </message> <message name="smsSendPacketResponse"> <part name="output" element="tns:smsSendPacketResponse"/> </message> <portType name="WSSMSPort"> <operation name="smsSendPacket"> <documentation>Sends SMS in Packet mode (TTL used in seconds)</documentation> <input message="tns:smsSendPacket"/> <output message="tns:smsSendPacketResponse"/> </operation> </portType> <binding name="WSSMSBinding" type="tns:WSSMSPort"> <soap:binding style="document" transport="http://schemas. xmlsoap. org/soap/http"/> <operation name="smsSendPacket"> <soap:operation soapAction="http://*****/wssms. u#smsSendPacket"/> <input> <soap:body use="literal"/> </input> <output> <soap:body use="literal"/> </output> </operation> </binding> <service name="WSSMSService"> <port name="WSSMSPort" binding="tns:WSSMSBinding"> <soap:address location="http://localhost:8080/fssp-mvv/wssms"/> </port> </service> </definitions> |
Примеры запроса:
<?xml version='1.0' encoding='UTF-8'?> <S:Envelope xmlns:S="http://schemas. xmlsoap. org/soap/envelope/"> <S:Body> <ns2:smsSendPacket xmlns:ns2="http://*****/wssms. u"> <inSMSPaket> <From>*****</From> <maxRetries>3</maxRetries> <maxInterval>3600</maxInterval> <maxTTL>60</maxTTL> <PacketSMS packet_id=""> <item> <InternalKey>85</InternalKey> <ipNumber>4801/13/17/65</ipNumber> <Recipient></Recipient> <Message>ЩЕЛОКОВА ЖАННА ГЕННАДЬЕВНА, в отношении Вас 26.09.2013 возбуждено ИП 4801/13/17/65. Подробности на http://*****/ip=4801/13/17/65</Message> </item> <item> <InternalKey>86</InternalKey> <ipNumber>4802/13/17/65</ipNumber> <Recipient></Recipient> <Message>ЩЕЛОКОВА ЖАННА ГЕННАДЬЕВНА, в отношении Вас 26.09.2013 возбуждено ИП 4802/13/17/65. Подробности на http://*****/ip=4802/13/17/65</Message> </item> </PacketSMS> </inSMSPaket> </ns2:smsSendPacket> </S:Body> </S:Envelope> |
Примеры ответа:
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas. xmlsoap. org/soap/envelope/" xmlns:wss="http://*****/wssms. u"> <soapenv:Body> <wss:smsSendPacketResponse> <return> <PacketSMSID packet_id=""> <item> <ID></ID> <ResultCode>0</ResultCode> <Status>1</Status> <PartCount>3</PartCount> <InternalKey>85</InternalKey> <ipNumber>4801/13/17/65</ipNumber> <Recipient></Recipient> </item> <item> <ResultCode>1</ResultCode> <Status>0</Status> <InternalKey>86</InternalKey> <ipNumber>4802/13/17/65</ipNumber> <Recipient></Recipient> </item> </PacketSMSID> </return> </wss:smsSendPacketResponse> </soapenv:Body> </soapenv:Envelope> |
4. Электронный сервис ФССП России для приема сведений о доставке СМС сообщений
4.1. Оператором рассылки СМС-сообщений должен быть реализован клиент электронного сервиса для передачи информации о доставке СМС сообщений.
4.2. Клиент электронного сервиса оператора рассылки СМС-сообщений должен обеспечивать взаимодействие с электронным сервисом ФССП России в соответствии с форматами, опубликованными на официальном сайте ФССП России (раздел «Участникам межведомственного взаимодействия», http://www. *****/mvv_fssp/).
4.3. Информация о доставке СМС-сообщения предоставляется сообщением «Информация об уведомлении должника о возбуждении ИП» (DebtorIpNotify).


