TC Kimlik No SMS API

SOAP API

Mobildev SOAP API, SOAP teknolojisini kullanarak geliştirilen üç katmanlı mimariye sahip Mobildev TC Kimlik SMS Gateway’a istemci ucundan gelen talepleri belirli standartlara uygun olarak gönderilmesini sağlamak amacı ile geliştirilmiştir.

Yazılım geliştiriciler, bu servise http://apitc.mobildev.net/api.asmx  (bundan böyle gateway olarak anılacaktır)  adresinden ulaşabilirler.

Uyarılar

Mobildev SOAP API çözümü aşağıdaki uyarılar göz önünde bulundurularak kullanılmalıdır.

• Mesaj içeriğinde Türkçe karakterler, LineFeed, Enter, Tab, ”~” , ”€” gibi karakterler bulunmamalıdır.

• TC Kimlik numaraları 12345678912 şeklinde olmalıdır.

• Mobildev SMS Gateway, toplu mesaj gönderimleri için tasarlanmış bir çözümdür. Yollanacak paketler mümkün olduğunca tek bir XML ifadesi hazırlanarak gateway’a yollanmalıdır.

XML API

Mobildev XML API, XML teknolojisi ve HTTP protokolü kullanarak gerçekleştirilen, fiziksel üç katmanlı mimariye sahip Mobildev SMS Gateway’a istemci ucundan gelen taleplerin belirli standartlara uygun olarak gönderilmesini sağlamak amacı ile geliştirilmiştir.

Yazılım geliştiriciler, bu belgede belirtilen şekilde hazırlamış oldukları XML ifadelerini, http://apitc.mobildev.net/xmlapi.aspx (bundan sonra gateway olarak anılacaktır.) adresine, kendi çözümlerinde bir XMLHTTP isteği oluşturarak gönderirler. Gönderilen XML ifadesi Mobildev XML Parser tarafından işlenir. Eğer XML ifadesinde ya da XML ifadesi içerisinde bulunan parametre düğümlerinin herhangi birinde hata oluşmuşsa, yakalanan hata HTTP üzerinden önceden tanımlı bir kod olarak göndericiye iletilir. Eğer bir hata olmamışsa gönderilmiş olan XML ifadesinin işlevine uygun geri dönüş ifadesi hazırlanıp HTTP üzerinden göndericiye iletilir. Önceden tanımlı hata kodları, belgenin ilgili ayrımında ayrıntılı olarak açıklanacaktır.

Uyarılar

Mobildev XML API çözümü aşağıdaki uyarılar göz önünde bulundurularak kullanılmalıdır.

• Mesaj içeriğinde Türkçe karakterler, LineFeed, Enter,Tab,”~” ,”€” gibi karakterler bulunmamalıdır.

• TC Kimlik numaraları 12345678912 şeklinde olmalıdır.

• Mobildev SMS Gateway, toplu mesaj gönderimleri için tasarlanmış bir çözümdür. Yollanacak paketler mümkün olduğunca tek bir XML ifadesi hazırlanarak gateway’a yollanmalıdır.

SOAP API

Hata Kodu Açıklama 01 Hatalı kullanıcı adı, şifre veya bayi kodu bilgisi 02 Yetersiz kredi (Mesaj gönderimi), Böyle bir mesaj kodu (ID) yok, Paket işlenmemiş veya gateway tarafında beklemede (raporlamada) 06 Tanımsız originator (gönderen) bilgisi 07 Mesaj Kodu (ID) yok 08 Verilen tarihler arasında, SMS gönderimi yok 09 Tarih alanları boş, hatalı 10 SMS gönderilemedi 11 Tanımlanamayan hata

XML API 

SOAP API 

public string GetInfo(string username, string companycode, string password)

Örnek SOAP Verisi

Geri dönüş değerlerinde bulunan <10> LineFeed karakterini temsil etmektedir. Originator bilgisi SMS gönderimlerinizde hedef GSM numarasının “Gönderen” kısmında çıkacak olan bilgiyi ifade etmektedir. Bu bilgi 11 karakterlik nümerik ya da alfa nümerik karakterlerden oluşan (Türkçe ve &,<,> gibi özel karakterler içermeyen) bir ifade olabilir.

XML API

Aşağıdaki XML ifadesini parametre düğümlerine istenen bilgileri ekleyerek Gateway’a yolladığınızda kullanıcı kredi bilgisi ve originator tanımları geri dönüş değeri olarak gönderilir:

Yukarıdaki XML ifadesinde;

UserName parametre düğümü, Mobildev’de tanımlı kullanıcı adınızı ve bayi kodunuzu,
PassWord parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
Action parametre düğümü, gönderilen XML ifadesinin hangi işlev için gönderildiği bilgisini ifade eder.

Not: UserName parametre düğümüne değişken aktarılırken dikkat edilmesi gerekmektedir. Aktarılırken parametre değeri username-company_code şeklinde olmalıdır. Buradaki username parametresi kullanıcı adınızı, company_code parametresi ise bağlı olduğunuz kanalı ifade etmektedir. (Bkz. Örnek 5.4.1)

Örnek 5.4.1 – Kullanıcı bilgileri kontrolü için hazırlanmış XML ifadesi

test-mb1000
123456
4
 

Not: “mb1000” değeri her kanal için farklı olmaktadır. Mobildev SMS Hizmetleri’yle son kullanıcı şeklinde çalışıyorsanız company_code parametre değeri olarak “mb1000”, kanal şeklinde çalışıyorsanız sizin adınıza tanımlanmış olan değeri kullanmalısınız.

Yukarıdaki XML ifadesini bir XMLHTTP isteği oluşturup Gateway’a gönderdiğinizde aşağıdaki dönüş değerini alırsınız;

1- İşlem başarılıysa;

Kredi Sayısı<10>
Originator1<10>
Originator2<10>
OriginatorN

2- Hata oluşmuşsa Bkz. Tablo 1

Geri dönüş değerinde bulunan <10> LineFeed karakterini temsil etmektedir. Originator bilgisi SMS gönderimlerinizde hedef TC Kimlik numarasına ait GSM numarasının “Gönderen ” kısmında çıkacak olan bilgiyi ifade etmektedir. Bu bilgi 11 karakterlik nümerik ya da alfa nümerik karakterlerden oluşan (Türkçe karakter ve &,<,> gibi özel karakterler içermeyen) bir ifade olmalıdır.

SOAP API

Mobildev XML API SMS gönderimleri için iki çeşit XML ifadesi sunmaktadır;

1. SMS To Many

2. SMS MultiSenders
   

SMS To Many

SMSToMany aynı mesajı birden fazla TC Kimlik numarasına gönderirken kullanılan fonksiyondur. Fonksiyon parametreleri arasında yer alan tcKimlikList’e mesajların gönderileceği TC Kimlik numaraları arasına virgül koyularak yazılır.

[WebMetot]
public string SMSToMany(string username, string companycode, string password, string tcKimlikList, string message, string sdate, string originator)

Örnek SOAP Verisi

Gateway’a ulaştığında iki çeşit geri dönüş değeri alınır:

1. İşlem başarılıysa: “ID: 3152005” seklinde mesaj gönderim paketine ait TimerID bilgisi döner.

2. Hata oluşmuşsa: Bkz. Tablo 1
    

Geri Dönüş Örnek SOAP Verisi

SMS MultiSenders ifadesi, farklı mesajları farklı TC Kimlik numaralarına ait GSM numaralarına göndermek için kullanılır.

[WebMetot]
public string MultiSender(string username, string companycode, string password, SMSInfo[] smsInfoArray, string sDate, string originator)

Örnek SOAP Verisi

Gateway’a ulaştığında iki çeşit geri dönüş değeri alınır:

1. İşlem başarılıysa: “ID: 3152005” seklinde mesaj gönderim paketine ait TimerID bilgisi döner.

2. Hata oluşmuşsa: Bkz. Hata Kodları

Geri Dönüş Örnek SOAP Verisi

XML API

Mobildev XML API SMS gönderimleri için iki çeşit XML ifadesi sunmaktadır;

1. SMS To Many

2. SMS MultiSenders

SMSToMany

SMS To Many ifadesi, aynı mesajı birden fazla TC kimlik numarasına göndermek için kullanılır. Önerilen paket boyutu 30.000 adettir.

Aşağıdaki örnekte SMSToMany XML ifadesi örneği gösterilmektedir.

Örnek 5.5.1.1. SMS To Many XML ifade örneği

UserName parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
Action parametre düğümü, gönderilen XML ifadesinin hangi işlev için gönderildiği bilgisini,
Mesgbody parametre düğümü, gönderilecek mesaj içeriğini,
TcKimlik parametre düğümü, mesajın gönderileceği TC Kimlik numaralarını,
Originator parametre düğümü, mesajın gönderildiği TC Kimlik numarasına ait GSM numarasında gönderen kısmında çıkacak ifadeyi,
SDate parametre düğümü, ggaayyyyssdd (GünAyYılSaatDakika) şeklinde gönderim zamanını ifade eder.

Eğer Originator parametre düğümüne herhangi bir değer girmezseniz kullanıcıya ait tanımlanmış olan ilk Originator bilgisi kullanılır. Eğer SDate parametre düğümüne bir değer girmezseniz mesaj gönderim işlemi hemen baslar. Bir değer belirtirseniz mesaj gönderim işlemi o tarihte yapılır.

XML ifadesi Gateway’a ulaştığında iki çeşit geri dönüş değeri alınır:

1. İşlem başarılıysa: “ID: 3152005” şeklinde mesaj gönderim paketine ait TimerID bilgisi döner.
2. Hata oluşmuşsa: Bkz. Hata Kodları

SMS MultiSenders

SMS MultiSenders ifadesi, farklı mesajları farklı TC Kimlik numaralarına ait GSM numaralarına göndermek için kullanılır. Önerilen SMS paketi boyutu 30.000 adettir.
Aşağıdaki örnekte SMS MultiSenders XML ifadesi gösterilmektedir.

Örnek 5.5.2.1. SMS MultiSenders XML Örneği

Yukarıdaki XML ifadesinde:

UserName parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
Action parametre düğümü, gönderilen XML ifadesinin hangi işlev için gönderildiği bilgisini,
Mesgbody parametre düğümü, gönderilecek mesaj içeriğini,
TcKimlik parametre düğümü, mesajın gönderileceği TC Kimlik numarasını,
Originator parametre düğümü, mesajın gönderildiği TC Kimlik numarasına ait GSM numarasında gönderen kısmında çıkacak ifadeyi,
SDate parametre düğümü, ggaayyyyssdd (GünAyYılSaatDakika) şeklinde gönderim zamanını ifade eder.

Eğer Originator parametre düğümü herhangi bir değer girmezseniz kullanıcıya ait tanımlanmış olan ilk Originator bilgisi kullanılır. Eğer SDate parametre düğümüne bir değer girmezseniz mesaj gönderim işlemi hemen başlar. Bir değer belirtirseniz mesaj gönderim işlemi o tarihte yapılır.

XML ifadesi Gateway’a ulaştığında iki çeşit geri dönüş değeri alınır:

1. İşlem başarılıysa: “ID: 3152005” şeklinde mesaj gönderim paketine ait TimerID bilgisi döner.
2. Hata oluşmuşsa: Bkz. Hata Kodları

SOAP API

Mobildev TC Kimlik ile SMS gönderme SOAP web servisi iki çeşit raporlama olanağı sunmaktadır. Bunlar;

1. Tarih bazında raporlama

2. Gönderilen mesaj bazında raporlama

Tarih Bazında Raporlama (ReportByDate)

Tarih bazında raporlama, belirtilen iki tarih arasında yapılan SMS gönderim hareketlerinin toplu halde raporlanmasında kullanılır.

[WebMetot]
public string ReportByDate(string username, string companycode, string password, string FDate, string LDate)

Örnek SOAP Verisi

TimerID Bazında Raporlama (ReportByID)

TimerID (Mesaj kodu) bazında raporlama bir SMS paketine ait mesaj gönderim hareketlerini raporlamada kullanılır.

[WebMetot]
public string ReportByID(string username, string companycode, string password, string packetid)

Örnek SOAP Verisi

  1- İşlem başarılıysa:

“TimerID<32>TC Kimlik Numarası<32>Durum<10>” şeklinde (Bkz. Örnek 5.5.2.2)

Örnek 5.5.2.2 TimerID bazında raporlama geri dönüş değeri
1234<32>12345678912<32>2<10>
1234<32>12345678913<32>3<10>
1234<32>12345678914<32>1<10>

NOT: Durum bilgisinde: “1” mesajın beklemede olduğunu, “2” gönderildiğini, “3” ise iletilmediğini belirtir. Geri dönüş değerlerinin tümünde bulunan <32> boşluk karakterini, <10> LineFeed karakterini temsil etmektedir.

 2- Hata oluşmuşsa: Bkz. Hata Kodları

Örnek Geri Dönüş SOAP Verisi

XML API

Mobildev XML API gönderilen SMS mesajlarının raporlanması için iki çeşit raporlama seçeneği sunmaktadır:

1. Tarih bazında raporlama
2. Gönderilen mesaj bazında raporlama

Tarih Bazında Raporlama

Tarih bazında raporlama, belirtilen iki tarih arasında yapılan SMS gönderim hareketlerinin toplu halde raporlanmasında kullanılır.

Aşağıdaki örnekte tarih bazında raporlama için gereken XML ifadesi gösterilmektedir.

Örnek 5.5.1.1 Tarih bazında raporlama için gerekli XML ifadesi

Yukarıdaki XML ifadesinde:

UserName parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
Action parametre düğümü, gönderilen XML ifadesinin hangi işlev için gönderildiği bilgisini,
FDate parametre düğümü, raporun başlangıç tarihini (“Yıl-Ay-Gün” şeklinde),
LDate parametre düğümü, raporun bitiş tarihini (“Yıl-Ay-Gün” seklinde) ifade etmektedir.
XML ifadesi Gateway’a ulaştığında iki çeşit geri donuş değeri alınır:

1. İşlem başarılıysa:
“TimerID<32>TC Kimlik Numarası<32>Durum<10>” seklinde (Bkz. Örnek 5.5.1.2)

Örnek 5.5.1.2 Tarih bazında raporlama geri dönüş değeri

1234<32>12345678912<32>2<10>
1234<32>12345678913<32>3<10>
1234<32>12345678914<32>1<10>

NOT: Durum bilgisinde: “1” mesajın beklemede olduğunu, “2” gönderildiğini, “3” ise
iletilmediğini belirtir. Geri dönüş değerlerinin tümünde bulunan <32> boşluk karakterini, <10>
LineFeed karakterini temsil etmektedir.

2. Hata oluşmuşsa: Bkz. Hata Kodları

TimerID Bazında Raporlama

TimerID (Mesaj kodu) bazında raporlama bir SMS paketine ait mesaj gönderim hareketlerini raporlamada kullanılır.

Aşağıdaki örnekte TimerID bazında raporlama için gerekli XML ifadesi gösterilmektedir.

Örnek 5.5.2.1 TimerID bazında raporlama için gerekli XML ifadesi

Yukarıdaki XML ifadesinde:

UserName parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametre düğümü, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
Action parametre düğümü, gönderilen XML ifadesinin hangi işlev için gönderildiği bilgisini,
MsgID parametre düğümü, rapor almak istenilen SMS paketine ait TimerID bilgisini ifade etmektedir.
XML ifadesi Gateway’a ulaştığında iki çeşit geri donuş değeri alınır:

1. İşlem başarılıysa:
“TimerID<32>TC Kimlik Numarası<32>Durum<10>” seklinde (Bkz. Örnek 5.5.2.2)
Örnek 5.5.2.2 TimerID bazında raporlama geri dönüş değeri
1234<32>12345678912<32>2<10>
1234<32>12345678913<32>3<10>
1234<32>12345678914<32>1<10>

NOT: Durum bilgisinde: “1” mesajın beklemede olduğunu, “2” gönderildiğini, “3” ise iletilmediğini belirtir. Geri dönüş değerlerinin tümünde bulunan <32> boşluk karakterini, <10> LineFeed karakterini temsil etmektedir.

2. Hata oluşmuşsa: Bkz. Hata Kodları