Biotekno.Mobiliva.XmlSmsSender 1.6.17

XmlSmsSender

SmsToMany: Aynı mesajı birden farklı kişiye göndermemize yarar. SmsToOne: Bir kişiye bir mesaj göndermemize yarar.

Ayarların verilmesi

Paket iki farklı ayar okuma yaklaşımını destekler:

1. Önerilen kullanım: SmsSenderOptions nesnesini uygulama tarafında oluşturup ilgili sınıfa constructor üzerinden vermek.
2. Eski kullanım: Uygulamanın çalışma dizinindeki settings.txt dosyasından KEY=VALUE formatında ayar okumak.

Yeni projelerde SmsSenderOptions kullanılması önerilir. settings.txt desteği geriye dönük uyumluluk için devam eder.

SmsSenderOptions ile kullanım

var options = new SmsSenderOptions
{
    XML_SENT_SERVLET = "https://smsapi.jetsms.com.tr/SMS-Web8/xmlsms",
    XML_REPORT_SERVLET = "https://smsapi.jetsms.com.tr/SMS-Web8/xmlreport",
    XML_DATE_REPORT_SERVLET = "https://smsapi.jetsms.com.tr/SMS-Web8/xmldatereport",
    REPORT_TIME_OUT = 30
};

var smsToOne = new SmsToOne(options);
var smsToMany = new SmsToMany(options);

ASP.NET Core projelerinde bu değerler appsettings.json içinde tutulabilir:

{
  "SmsSenderOptions": {
    "XML_SENT_SERVLET": "https://smsapi.jetsms.com.tr/SMS-Web8/xmlsms",
    "XML_REPORT_SERVLET": "https://smsapi.jetsms.com.tr/SMS-Web8/xmlreport",
    "XML_DATE_REPORT_SERVLET": "https://smsapi.jetsms.com.tr/SMS-Web8/xmldatereport",
    "REPORT_TIME_OUT": 30
  }
}

Uygulama tarafında bind etmek için:

services.Configure<SmsSenderOptions>(
    Configuration.GetSection("SmsSenderOptions"));

Kullanım örneği:

public class SmsService
{
    private readonly SmsSenderOptions _options;

    public SmsService(IOptions<SmsSenderOptions> options)
    {
        _options = options.Value;
    }

    public ResponseFromHostV2 Send()
    {
        var sms = new SmsToOne(_options)
        {
            Username = "username",
            Password = "password",
            Channel = "channel",
            Originator = "Headers",
            ProcessType = "xml"
        };

        sms.setMessage("5555555555", "message text");
        return sms.sendMessageV2();
    }
}

settings.txt ile kullanım

Bazı eski akışlar ve proxy ayarları settings.txt dosyasından okunur. Dosya paketin içinde değil, paketi kullanan uygulamanın çalışma dizininde bulunmalıdır. ASP.NET/IIS veya servis ortamlarında bu dizin uygulamanın yayın çıktısı ya da process working directory'si olabilir.

Örnek settings.txt:

XML_SENT_SERVLET=https://smsapi.jetsms.com.tr/SMS-Web8/xmlsms
USE_PROXY=0
PROXY_ADRES=
PROXY_PORT=
PROXY_USER_NAME=
PROXY_PASSWORD=
DOMAIN=
SslProtocol=Tls12

settings.txt içinde desteklenen başlıca değerler:

Notlar:

• settings.txt dosyası bulunamazsa, dosyayı kullanan eski akışlarda hata alınabilir.
• Dosya formatı satır başına KEY=VALUE şeklinde olmalıdır.
• SslProtocol için önce uygulama konfigürasyonu kontrol edilir; değer bulunamazsa settings.txt fallback olarak denenir.

Örnek kullanım aşağıdaki gibidir.

public async Task<string> SmsToMany()
{
    var smsToMany = new SmsToMany
    {
        Version = "",
        ProcessType = "xml",
        Username = "username",
        Password = "password",
        ExclusionTimeStart = "",
        ExclusionTimeStop = "",
        Channel = "channel",
        Text = "message text",
        MessageType = "message type",
        ChannelType = "channel type",
        IsTCKN = false,
        IsVKN = false,
        IYSCode = "iys code",
        Reference = "referance value",
        TotalMessageCount = 1,
        IsBlacklistFilterActive = false,
        StartDate = DateTime.Now.ToString("ddMMyyyyHHmm00"),
        ExpireDate = DateTime.Now.AddDays(1).ToString("ddMMyyyyHHmm00"),
        Originator = "Headers"
    };
    var numberList = new List<string>
    {
        "5555555555"
        //NumberList
    };
    smsToMany.setGsmNumbers(numberList.ToArray());
    var xmlRequest = smsToMany.createXmlData();
    //Xml sms send address
    var resultString = await PostXml.PostXmlData(
        xmlRequest, "::1");
    var result = new ResponseFromHost();
    var parsedResult = resultString.Split(" ");

    //Result code 00 ise gönderim başarılıdır ve result.Message değeri processId olur
    result.Code = parsedResult[0].Replace("\n", string.Empty);
    return result.Code.Equals("00") ? result.Message : $"Error Code:{result.Code}";
}

SmsToMany class’ının içini xmle’e çevirmek istediğimiz alanlar ile dolduruyoruz. Daha sonra o class’a verdiğimiz referanstan içindeki setGsmNumbers methonuda bir gsm Numara arrayi veriyoruz ve ondan sonra gene ilgili referanstan createXmlData methodunu çağırarak xme formata çeviriyoruz ve PostXml static class’ının içindeki PostXmlData methoduna ilgili sunucu adresimizi ve göndereceğimiz xml format vererek işlemi gerçekleştiriyoruz. Eğer sunucu adresi vermezsek default "https://api.jetsms.com.tr/SMS-Web8/xmlsms" budur. PostXmlData dan geriye dönen result eğer code 00 ise gönderim başarılıdır ve mesajı ProcessId olur.

 public async Task<string> SmsToOne()
{
    var smsToOne = new SmsToOne( new SmsSenderOptions()
    {
        XML_SENT_SERVLET = "https://smsapi.jetsms.com.tr/SMS-Web8/xmlsms"
    })
    {
        Version = "",
        ProcessType = "xml",
        Username = "UserName",
        Password = "Password.",
        ExclusionTimeStart = "",
        ExclusionTimeStop = "",
        Channel = "Channel",
        MessageType = "message type",
        ChannelType = "channel type",
        IsTCKN = false,
        IsVKN = false,
        IYSCode = "iys code",
        Reference = "referance value",
        TotalMessageCount = 1,
        IsBlacklistFilterActive = false,
        StartDate = DateTime.Now.ToString("ddMMyyyyHHmm00"),
        ExpireDate = DateTime.Now.AddDays(1).ToString("ddMMyyyyHHmm00"),
        Originator = "Headers"
    };
    smsToOne.setMessage("Number", "Message");

    var xmlRequest = smsToOne.sendMessageV2();
    //Xml sms send address

    var result = new ResponseFromHost();


    //Result code 00 ise gönderim başarılıdır ve result.Message değeri processId olur
    result.Code = xmlRequest.ResponseCode;
    result.Message = xmlRequest.ResponseMessage;
    return result.Code.Equals("00") ? result.Message : $"Error Code:{result.Code}";
}

SSL/TLS protokol ayarını farklı konfigürasyonlardan (ör. app.config, settings.txt ve .NET Core için appsettings.json) nasıl kullanacağınız gösteren örnekler:

Aşağıdaki değerleri alabilir.

• Tls
• Tls11
• Tls12
• Tls13

App.config Dosyası:

<configuration>
  <appSettings>
    <add key="SslProtocol" value="Tls12" />
  </appSettings>
</configuration>

settings.txt Dosyası

SslProtocol=Tls11

appsettings.json Dosyası:

{
  "SslProtocol": "Tls12"
}