XML SMS API

Mobildev XML Interfaces, XML teknolojisi ve HTTP protokolü kullanılarak gerçekleşen,fiziksel üç katmanlı mimariye sahip Mobildev SMS Gateway’a istemci ucundan gelen taleplerin belirli standartlara uygun olarak gönderilmesini sağlamak amacıyla geliştirilmiştir. Mobildev API içindeki diğer geliştirici araçları, Mobildev XML Interfaces çözümümüzü temel alır.

Yazılım geliştiriciler, ilgili belgede belirtilen kriterlere uygun olarak  hazırlamış oldukları XML ifadelerini, http://gateway.mobilus.net/com.mobilus (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çinde bulunan parametre düğümlerinin herhangi birinde bir hata oluşmuşsa, yakalanan hata HTTP üzerinden önceden tanımlı bir kod olarak göndericiye iletilir. Eğer bir hata oluşmamışsa gönderilmiş olan XML ifadesinin işlevine uygun geri dönüş ifadesi hazırlanıp http üzerinden göndericiye iletilir.

Aşağıdaki XML ifadesini parametre düğümlerine istenen bilgileri ekleyerek Gateway'a yolladığınızda kullanıcı kontör bilgisi ve orijinatör tanımları geri dönüş değerleri olarak gönderilir:

Yukarıdaki XML ifadesinde:

• UserName parametre düğümü, Mobiltim SMS servislerinde tanımlı kullanıcı adınızı,

• PassWord parametre düğümü, 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ılan 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.

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

Not: "mb1000" değeri her kanal için farklıdır. Mobiltim'in sunduğu 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 geri dönüş değerlerini alırsınız:

• İşlem başarılıysa:

Kontör sayısı<10>
Originator1<10>
Originator2<10>
OriginatorN

• Hata oluşmuşsa: Bknz. Hata kodları

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 alfanümerik karakterlerden oluşan (Türkçe ve &, <, > gibi özel karakterler içermeyen) bir ifade olabilir.

 XML Interfaces SMS gönderimi için iki çeşit XML ifadesi sunmaktadır:

SMS To Many

SMS To Many ifadesi, aynı mesajı birden fazla GSM numarasına göndermek için kullanılır. Önerilen SMS paketi boyutu 30.000 adettir. Aşağıdaki örnekte SMS To Many XML ifadesi gösterilmektedir.

Örnek: SMS To Many XML ifadesi örneği


Yukarıdaki XML ifadesinde:

• UserName parametre düğümü, Sistemimizde tanımlı olan kullanıcı adınızı,

• PassWord parametre düğümü, Sistemimizde 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,

• Numbers parametre düğümü, mesajın gönderileceği GSM numaralarını,

• Originator parametre düğümü, mesajın gönderildiği 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 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:

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

• Hata oluşmuşsa: Bknz. Hata kodları

SMS MultiSenders

SMS MultiSenders ifadesi, farklı mesajları farklı 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: SMS MultiSenders XML ifadesi örneği


Yukarıdaki XML ifadesinde:

• UserName parametre düğümü, Sistemimizde tanımlı olan kullanıcı adınızı,

• PassWord parametre düğümü, Sistemimizde 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,

• Number parametre düğümü, mesajın gönderileceği GSM numarasını,

• Originator parametre düğümü, mesajın gönderildiği 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 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:

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

• Hata oluşmuşsa: Bknz. Hata kodları

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

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: 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” şeklinde) ifade etmektedir.

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

• İşlem başarılıysa:

“TimerID<32>GSM Numarası<32>Durum<10>” şeklindedir.

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

1234<32>905358838799<32>2<10>
1234<32>905428838799<32>3<10>
1234<32>905558838799<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.

• Hata oluşmuşsa: Bknz. 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: 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 dönüş değeri alınır:

• İşlem başarılıysa: “TimerID<32>GSM Numarası<32>Durum<10>” şeklindedir.

Örnek: TimerID bazında raporlama geri dönüş değeri

1234<32>905448838799<32>2<10>
1234<32>905378838799<32>3<10>
1234<32>905058838799<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.

• Hata oluşmuşsa: Bknz.Hata kodları