Работа с сообщениями

Официальная реализация API MainSMS.ru для C#

MainSMS.ru это платформа для транзакционных SMS уведомлений и SMS рассылок.

Установка

Проект собран для .NET 45 и .NET Platform Standard 1.4.

Установка из менеджера пакетов Nuget или из командной строки

PM> Install-Package MainSMS

Использование

Подключение пространства имен

using MainSms;

Ответы на запросы

Любой запрос к API, возвращает объект класса который содержит поля:

Поле	Описание	Значения
status	Статус выполнения запроса	success или error
erorr	Код ошибки если статус error	Смотрите коды ошибок для вызываемого метода
message	Описание ошибки если статус error	Смотрите описание ошибок для вызываемого метода
response	Исходный XML ответа на API вызов

А так же поля доступные только для конкретного ответа на запрос, например при запросе баланса доступно поле balance.

Работа с сообщениями

SmsMessage sms = new SmsMessage(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо is_test и use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts is_test - если true то смс не будут отправляться. use_ssl - если true то будет использоваться протокол https.

Запрос баланса

ResponseBalance responseBalance = sms.getBalance();
if (responseBalance.status == "success") Console.WriteLine(responseBalance.balance);
else Console.WriteLine("Error - " + responseBalance.message);

Поля класса ResponseBalance

Поле	Описание
balance	Остаток средств на счете

Расчет стоимости отправки

ResponsePrice responsePrice = sms.getMessagesPrice("sender_name", "89121231234,9121231235", "test text");
if (responsePrice.status == "success") Console.WriteLine($"Частей в одной смс {responsePrice.parts}, всего частей {responsePrice.count}, стоимость отправки {responsePrice.price}");
else Console.WriteLine("Error - " + responsePrice.message);

Поля класса ResponsePrice

Поле	Описание
recipients	Массив номеров получателей
balance	Остаток средств на счете
parts	Количество частей в одной смс
count	Всего частей смс
price	Стоимость отправки

Отправка SMS сообщения

ResponseSend responseSend = sms.sendSms("sender_name", "79609701234", "test SMS message");
if (responseSend.status == "success") Console.WriteLine($"Частей в одной смс {responseSend.parts}, всего частей {responseSend.count}, стоимость отправки {responseSend.price}");
else Console.WriteLine("Error - " + responseSend.message);

Меток sendSms, может принимать в качестве четвертого параметра параметр типа DateTime, со временем на которое необходимо запланировать отправку сообщения. Время указывается в часовом поясе кабинета mainsms.ru

Поля класса ResponseSend

Поле	Описание
recipients	Массив номеров получателей
messages_id	Массив идентификаторов сообщений
balance	Остаток на средств счете
parts	Количество частей в одной смс
count	Всего частей смс
price	Стоимость отправки
test	1 если режим тестирования и 0 если сообщения отправляются

Отправка Viber сообщения

ResponseSend responseSend = sms.sendViber("mainsms", "79609701234", "test Viber message", "http://autodrive.org.ua/wp-content/uploads/2018/11/final-logo-example.png", "Buy now", "https://mainsms.ru");
if (responseSend.status == "success") Console.WriteLine($"Частей в одном сообщении {responseSend.parts}, всего частей {responseSend.count}, стоимость отправки {responseSend.price}");
else Console.WriteLine("Error - " + responseSend.message);

Меток sendViber, может принимать в качестве дополнительного параметра параметр типа DateTime, со временем на которое необходимо запланировать отправку сообщения. Время указывается в часовом поясе кабинета mainsms.ru

Отправка Viber или SMS сообщения

В случае если Viber сообщение доставить не получится, отправится SMS сообщение.

ResponseSend responseSend = sms.sendViberOrSms("mainsms", "79609701234", "test SMS message", "test Viber message", "http://autodrive.org.ua/wp-content/uploads/2018/11/final-logo-example.png", "Buy now", "https://mainsms.ru");
if (responseSend.status == "success") Console.WriteLine($"Частей в одном сообщении {responseSend.parts}, всего частей {responseSend.count}, стоимость отправки {responseSend.price}");
else Console.WriteLine("Error - " + responseSend.message);

Меток sendViberOrSms, может принимать в качестве дополнительного параметра параметр типа DateTime, со временем на которое необходимо запланировать отправку сообщения. Время указывается в часовом поясе кабинета mainsms.ru

Запрос статуса сообщения

ResponseStatus responseStatus = sms.getMessagesStatus("1234567");
if (responseStatus.status == "success") Console.WriteLine($"Статус сообщения 1234567 - {responseStatus.messages["1234567"]}, канал доставки - {responseStatus.channels["1234567"]}");
else Console.WriteLine("Error - " + responseStatus.message);

Поля класса ResponseStatus

Поле	Описание
messages	Хранилище ключ значение, где ключ это ID сообщения, а значение его статус
channels	Хранилище ключ значение, где ключ это ID сообщения, а значение канал отправки

Отмена запланированного сообщения

ResponseCancel responseCancel = sms.cancelMessages("1234567");
if (responseCancel.status == "success") Console.WriteLine($"Сообщение 1234567 - {responseCancel.messages["1234567"]}");
else Console.WriteLine("Error - " + responseCancel.message);

Поля класса ResponseCancel

Поле	Описание
messages	Хранилище ключ значение, где ключ это ID сообщения, а значение его статус (canceled)

Запрос информации о номерах

ResponseInfo responseInfo = sms.getPhonesInfo("9138857567");
if (responseInfo.status == "success") Console.WriteLine($"Номер 9138857567 принадлежит оператору - {responseInfo.info[0].name}");
else Console.WriteLine("Error - " + responseInfo.message);

Поля класса ResponseInfo

Поле	Описание
info	Массив объектов типа PhoneInfo

Поля класса PhoneInfo

Поле	Описание
phone	Номер телефона
code	Код оператора
region	Регион
name	Название оператора

Работа с группами получателей

SmsContactsGroup smsGroup = new SmsContactsGroup(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts use_ssl - если true то будет использоваться протокол https.

Запрос списка групп

ResponseGroupList responseGroupList = smsGroup.getGroupList(GroupType.User);
if (responseGroupList.status == "success") Console.WriteLine($"Всего групп - {responseGroupList.recipientsGroups.Count}");
else Console.WriteLine("Error - " + responseGroupList.message);

Поля класса responseGroupList

Поле	Описание
recipientsGroups	Массив объектов типа RecipientsGroup

Поля класса RecipientsGroup

Поле	Описание
id	Уникальный идентификатор группы
name	Название группы получателей
contacts	Количество контактов в группе
type	Тип группы

Создание группы

ResponseGroupCreate responseGroupCreate = smsGroup.createGroup("group name");
if (responseGroupCreate.status == "success") Console.WriteLine($"Группа {responseGroupCreate.name} создана, id - {responseGroupCreate.id}");
else Console.WriteLine("Error - " + responseGroupCreate.message);

Поля класса ResponseGroupCreate

Поле	Описание
id	Уникальный идентификатор группы
name	Название группы получателей

Удаление группы

ResponseGroupRemove responseGroupRemove = smsGroup.removeGroup("12345");
if (responseGroupRemove.status == "success") Console.WriteLine("Группа удалена");
else Console.WriteLine("Error - " + responseGroupRemove.message);

Поля класса ResponseGroupRemove

Поле	Описание
result	Ответ сеовера "ok"

Работа с получателями

SmsContact smsContact = new SmsContact(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts use_ssl - если true то будет использоваться протокол https.

Создание контакта

ContactInfo contactInfo = new ContactInfo();
contactInfo.phone = "79609709097";
contactInfo.group = "141515";
contactInfo.lastname = "Иванов";
contactInfo.firstname = "Николай";
contactInfo.patronymic = "Александрович";
contactInfo.birthday = "24.12.1987";
contactInfo.param1 = "Параметр 1";
contactInfo.param2 = "Параметр 2";
ResponseContactCreate responseContactCreate = smsContact.createContact(contactInfo);
if (responseContactCreate.status == "success")  Console.WriteLine("Получатель создан");
else Console.WriteLine("Error - " + responseContactCreate.message);

Поля класса ResponseContactCreate

Поле	Описание
phones	Массив из номеров которые удалось добавить
group	Массив ID групп в которых встречается номер

Запрос контакта

ResponseContactExists responseContactExists = smsContact.existsContact("79609709097");
if (responseContactExists.status == "success")  {
    Console.WriteLine($"Получатель найден, в группах {responseContactExists.contactInfo[0].group}");
}
else Console.WriteLine("Error - " + responseContactExists.message);

Поля класса ResponseContactExists

Поле	Описание
contactInfo	Массив объектов типа ContactInfo

Поля класса ContactInfo

Поле	Описание
phone	Номер телефона
group	id групп через строкой через запятую
lastname	Фамилия
patronymic	Отчество
birthday	День рождения в фотмате 29.01.1987
param1	Параметр 1
param2	Параметр 2

Удаление контакта

ResponseContactRemove responseContactRemove = smsContact.removeContact("79609709097, 79609709098");
if (responseContactRemove.status == "success")  {
    Console.WriteLine($"Удалено {responseContactRemove.phones.Count} контактов");
}
else Console.WriteLine("Error - " + responseContactRemove.message);

Поля класса ResponseContactRemove

Поле	Описание
phones	Массив удаленный номеров

Работа с рассылками

SmsSending smsSending = new SmsSending(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts is_test - если true то смс не будут отправляться. use_ssl - если true то будет использоваться протокол https.

Создание рассылки

SendingInfo sendingInfo = new SendingInfo();
sendingInfo.include = "141606";
sendingInfo.exclude = "141607";
sendingInfo.sender = "mainsms";
sendingInfo.message = "test_api_sending";
ResponseSendingCreate responseSendingCreate = smsSending.createSending(sendingInfo);
if (responseSendingCreate.status == "success")  Console.WriteLine($"Рассылка {responseSendingCreate.id} создана");
else Console.WriteLine("Error - " + responseSendingCreate.message);

Поля класса SendingInfo

Поле	Описание
include	Группы получателей через запятую
exclude	Исключенные группы получателей через запятую
message	Текст сообщения
sender	Имя отправителя
run_at	Время отправки сообщения в часовом поясе кабинета 03.10.2031 17:00
slowtime	Интервал для плавной рассылки, например отправлять каждые 10 минут
slowsize	Количество сообщений для плавной рассылки, от 10 до 10000
name	Название рассылки

Поля класса ResponseSendingCreate

Поле	Описание
id	ID рассылки
cost	Стоимость рассылки
parts	Количество частей в рассылке
contacts	Количество получателей в рассылке
include	Группы получателей через запятую
exclude	Исключенные группы получателей через запятую
name	Название рассылки

Запрос статуса рассылки

ResponseSendingStatus responseSendingStatus = smsSending.sendingStatus("166937");
if (responseSendingStatus.status == "success")  {
    Console.WriteLine($"Отправленно {responseSendingStatus.total}, доставлено {responseSendingStatus.delivered}");
}
else Console.WriteLine("Error - " + responseSendingStatus.message);

Поля класса ResponseSendingStatus

Поле	Описание
id	ID (номер) рассылки
total	Всего получателей
delivered	Количество доставленых смс
undelivered	Количество не доставленых смс
indelivered	Количество смс в статусе "Отправлено"

Работа с именами отправителя

SmsSender smsSender = new SmsSender(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts use_ssl - если true то будет использоваться протокол https.

Создание имени отправителя

ResponseSenderCreate responseSenderCreate = smsSender.createSender("api_test");
if (responseSenderCreate.status == "success")  Console.WriteLine($"Отправитель {responseSenderCreate.sender} создан");
else Console.WriteLine("Error - " + responseSenderCreate.message);

Поля класса ResponseSenderCreate

Поле	Описание
sender	Имя созданного отправителя

Удаление имени отправителя

ResponseSenderRemove responseSenderRemove = smsSender.removeSender("api_test");
if (responseSenderRemove.status == "success")  {
    Console.WriteLine($"Имя {responseSenderRemove.sender} удалено");
}
else Console.WriteLine("Error - " + responseSenderRemove.message);

Поля класса ResponseSenderRemove

Поле	Описание
sender	Имя созданного отправителя

Запрос списка имен отправителей

ResponseSenderList responseSenderList = smsSender.listSender();
if (responseSenderList.status == "success")  {
    Console.WriteLine($"Всего {responseSenderList.senders.Count} отправителей");
}
else Console.WriteLine("Error - " + responseSenderList.message);

Поля класса ResponseSenderList

Поле	Описание
senders	Список всех имен отправителей

Запрос имени отправителя установленного по умолчанию

ResponseSenderDefault responseSenderDefault = smsSender.defaultSender();
if (responseSenderDefault.status == "success")  {
    Console.WriteLine($"Отправитель по умолчанию - {responseSenderDefault.sender}");
}
else Console.WriteLine("Error - " + responseSenderDefault.message);

Поля класса ResponseSenderDefault

Поле	Описание
sender	Имя отправителя по умолчанию

Установка отправителя по умолчанию

ResponseSenderSet responseSenderSet = smsSender.setSender("api_test");
if (responseSenderSet.status == "success")  {
    Console.WriteLine($"Отправитель по умолчанию - {responseSenderSet.sender} установлен");
}
else Console.WriteLine("Error - " + responseSenderSet.message);

Поля класса ResponseSenderSet

Поле	Описание
sender	Имя отправителя по умолчанию
result	Строка в случае успеха ОК

Отправка пакета СМС

Позволяет одним запросом отправить до 100 сообщений с разным текстом, разным получателям.

SmsBatch smsBatch = new SmsBatch(project_id, api_key);

В качестве параметра передаем project_id, api_key и если необходимо use_ssl. project_id, api_key можно получить на странице https://mainsms.ru/office/api_accounts use_ssl - если true то будет использоваться протокол https.

Отправка

BatchMessagesList batchMessagesList = new BatchMessagesList();
batchMessagesList.addMessage("+79609701234", "test message1");
batchMessagesList.addMessage("+79609701235", "test message2");
batchMessagesList.addMessage("+79609701236", "test message3");
ResponseBatchSend responseBatchSend = smsBatch.sendBatch(batchMessagesList);
if (responseBatchSend.status == "success")  Console.WriteLine($"Общая стоимость сообщений {responseBatchSend.cost}");
else Console.WriteLine("Error - " + responseBatchSend.message);

Поля класса ResponseBatchSend

Поле	Описание
id	Идентификатор запроса
phones	Количество намеров на которые отправились сообщения
parts	Общее количество отправленных частей сообщений
cost	Общая стоимость отправленных сообщений
errors	Список пар ID -> Ошибка, для каждого сообщения хранит ошибку отправки, если она есть

Класс BatchMessagesList

Позволяет добавлять до 100 сообщений в список на отправку пакета смс.

BatchMessagesList batchMessagesList = new BatchMessagesList();
string message1_id = batchMessagesList.addMessage("+79609701234", "test message1");
string message2_id = batchMessagesList.addMessage("+79609701234", "test message2");
string message3_id = batchMessagesList.addMessage("+79609701234", "test message3", "custom_message_id_1");
batchMessagesList.removeMessage(message2_id);

В данном примере, мы добавляем в список на отправку 3 сообщения, первые 2 получат ID номер выданный автоматически, ID третьего сообщения будет равно строке "custom_message_id_1". Затем в качестве примера мы удалим из списка на отправку сообщение с message2_id.

Name		Name	Last commit message	Last commit date
Latest commit History 16 Commits
MainSms		MainSms
MainSmsDebug		MainSmsDebug
MainSmsTests		MainSmsTests
.gitignore		.gitignore
LICENSE		LICENSE
MainSms.sln		MainSms.sln
README.md		README.md

License

k0r1sh/mainsms_official

Folders and files

Latest commit

History

Repository files navigation

Официальная реализация API MainSMS.ru для C#

Установка

Использование

Подключение пространства имен

Ответы на запросы

Работа с сообщениями

Запрос баланса

Поля класса ResponseBalance

Расчет стоимости отправки

Поля класса ResponsePrice

Отправка SMS сообщения

Поля класса ResponseSend

Отправка Viber сообщения

Отправка Viber или SMS сообщения

Запрос статуса сообщения

Поля класса ResponseStatus

Отмена запланированного сообщения

Поля класса ResponseCancel

Запрос информации о номерах

Поля класса ResponseInfo

Поля класса PhoneInfo

Работа с группами получателей

Запрос списка групп

Поля класса responseGroupList

Поля класса RecipientsGroup

Создание группы

Поля класса ResponseGroupCreate

Удаление группы

Поля класса ResponseGroupRemove

Работа с получателями

Создание контакта

Поля класса ResponseContactCreate

Запрос контакта

Поля класса ResponseContactExists

Поля класса ContactInfo

Удаление контакта

Поля класса ResponseContactRemove

Работа с рассылками

Создание рассылки

Поля класса SendingInfo

Поля класса ResponseSendingCreate

Запрос статуса рассылки

Поля класса ResponseSendingStatus

Работа с именами отправителя

Создание имени отправителя

Поля класса ResponseSenderCreate

Удаление имени отправителя

Поля класса ResponseSenderRemove

Запрос списка имен отправителей

Поля класса ResponseSenderList

Запрос имени отправителя установленного по умолчанию

Поля класса ResponseSenderDefault

Установка отправителя по умолчанию

Поля класса ResponseSenderSet

Отправка пакета СМС

Отправка

Поля класса ResponseBatchSend

Класс BatchMessagesList

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages