Протокол взаимодействия с нашим СМС сервисом по протоколу HTTP XML (SOAP 1.1, SOAP 1.2)

Данный документ содержит описание механизма взаимодействия ПО клиента (в дальнейшем Клиент) и нашего СМС сервиса по протоколу SOAP 1.1 или 1.2

Этот протокол взаимодействия хорошо подходит для использования в платформе .net в качестве WebService.

Серверная платформа ООО "ИнфоСМС" и клиент компании обмениваются HTTP запросами, используя язык разметки XML, данные включаются в тело запроса.

Точка доступа

Запросы должны передаваться на сервер по URL: http://api.infosmska.ru/Interfaces/SmsServiceV2.asmx. Техническое описание методов взаимодействия доступны по этому же адресу.

Корректное WSDL описание доступно здесь.

Доступные методы

• GetBalance – запрос на получение баланса пользователя;
• SendMessage – отправляет сообщение адресату и возвращает идентификатор сообщения;
• SendMessages – отправляет сообщения адресатам и возвращает идентификаторы сообщений;
• GetMessageState – запрос на получение статуса сообщения по идентификаторам;
• GetMessagesState – запрос на получение статуса сообщений по идентификаторам;

Детальное описание методов

GetBalance

Возвращает баланс пользователя.

Входные параметры:

Наименование поля	Описание
login	Логин пользователя в системе. Тип данных: string
password	Пароль пользователя или MD5-хеш пароля. Тип данных: string

Результат:

Наименование поля	Описание
Balance	Баланс клиента. Тип данных: double
Error	Сообщение об ошибке. Тип данных: Errors

SendMessage

Отправляет сообщение адресату и возвращает идентификатор сообщения.

Входные параметры:

Наименование поля	Описание
login	Логин пользователя в системе. Тип данных: string
password	Пароль пользователя или MD5-хеш пароля. Тип данных: string
destinationAddress	Мобильный номер получателя сообщения, в международном формате: код страны + код сети + номер телефона. Пример: 7903123456. Тип данных: string
text	Текст сообщения. Тип данных: string
sourceAddress	Адрес отправителя сообщения. До 11 латинских символов или до 15 цифровых. Тип данных: string
validPerionInMinutes	Срок жизни сообщения в минутах. Тип данных: int

Результат:

Наименование поля	Описание
MessageIDs	Идентификаторы созданных сообщений. Тип данных: int[]
Error	Сообщение об ошибке. Тип данных: Errors

SendMessages

Отправляет сообщение адресатам и возвращает идентификаторы сообщений.

Входные параметры:

Наименование поля	Описание
login	Логин пользователя в системе. Тип данных: string
password	Пароль пользователя или MD5-хеш пароля. Тип данных: string
destinationAddresses	Мобильные номера получателей сообщений, в международном формате(не более 1000 штук): код страны + код сети + номер телефона. Пример: 7903123456. Тип данных: string
text	Текст сообщения. Тип данных: string
sourceAddress	Адрес отправителя сообщения. До 11 латинских символов или до 15 цифровых. Тип данных: string
validPerionInMinutes	Срок жизни сообщения в минутах. Тип данных: int

Результат:

Наименование поля	Описание
MessageIDs	Идентификаторы созданных сообщений. Тип данных: int[]
Error	Сообщение об ошибке. Тип данных: Errors

GetMessageState

Возвращает статус сообщения по идентификатору.

Входные параметры:

Наименование поля	Описание
login	Логин пользователя в системе. Тип данных: string
password	Пароль пользователя или MD5-хеш пароля. Тип данных: string
messageId	Идентификатор сообщения. Тип данных: int

Результат:

Наименование поля	Описание
MessageStates	Идентификаторы созданных сообщений. Тип данных: MessageStates[]
Error	Сообщение об ошибке. Тип данных: Errors

GetMessageState

Возвращает статус сообщений по идентификаторам.

Входные параметры:

Наименование поля	Описание
login	Логин пользователя в системе. Тип данных: string
password	Пароль пользователя или MD5-хеш пароля. Тип данных: string
messageIDs	Идентификаторы сообщений(не более 1000 штук). Тип данных: int[]

Результат:

Наименование поля	Описание
MessageStates	Идентификаторы созданных сообщений. Тип данных: MessageStates[]
Error	Сообщение об ошибке. Тип данных: Errors

Дополнительные типы данных

MessageStates

Статус сообщения

Значение	Описание
InQueue	В очереди
Deleted	Удалено
WrongDestAddress	Неверный адрес получателя
NotDelivered	Не доставлено
Delivering	Доставляется
PartialyDelivered	Частично доставлено
Delivered	Доставлено
NoTariff	Сообщение не отправлено по причине отсутствия необходимого тарифа
NoSMSCResponse	СМСЦ не передал информацию о статусе
MessageNotExists	Сообщение не найдено

Errors

Сообщение об ошибке

Значение	Описание
AuthorizationError	Ошибка авторизации
InvalidSourceAddress	Недопустимый адрес отправителя (адрес отправителя должен быть заведён в системе и допущен модератором)
InvalidDestinationAddresses	Ошибка в адресах получателей
InvalidMessageText	Недопустимый текст сообщения
InvalidMessageIDs	Ошибка в идентификаторах сообщений
UnknownError	Неизвестная ошибка. При возникновении этой ошибки, пожалуйста, обратитесь в администрацию сервиса.