COM Object SMS API

Mobildev COM Object API, kendi uygulamalarını SMS ile entegre etmek isteyen ve bu entegrasyon işlemi için faklı bir IDE kullanmak istemeyen geliştiriciler için IDE bağımsız olarak hazırlanmış bir COM çözümüdür.

Yazılım geliştiriciler, Mobildev COM Object API tarafından sunulan yöntemleri, bu belgede belirtilen şekilde kullanarak çağırırlar. Çağırılan yöntemler http://gateway.mobilus.net/com.mobilus (Bundan sonra Gateway olarak anılacaktır.) adresine, taşımış oldukları parametreleri aktarırlar.

Aktarılan parametreler Gateway tarafından işlenir. Eğer parametre bilgilerinde ya da gönderilen SMS paketinde 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 parametre ya da SMS paketine uygun dönüş ifadesi hazırlanıp HTTP üzerinden göndericiye iletilir. Önceden tanımlı hata kodları için hata kodları sayfasına bakabilirsiniz.

COM, kullanıcı bilgileri kontrolü için getinfo adıyla bir yöntem sunar.

Söz dizimi:

getinfo “UserName,”PassWord” şeklindedir.

Bu yöntemde:

UserName parametresi, sistemizde tanımlı kullanıcı adınızı,
PassWord parametresi, sistemimizde tanımlı olan kullanıcı adınıza ait şifreyi ifade etmektedir.

Not: UserName parametresine 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: getinfo yöntemi 

Not: “mb1000” değeri her kanal için farklı olmaktadır. Mobiltim'in sunduğu SMS servisini kullanmak için 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.

Getinfo yöntemini örnekte belirtildiği gibi çağırıp Gateway’a gönderdiğinizde aşağıdaki geri dönüş değerlerini alırsınız:

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

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

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

Mobildev COM Object, SMS gönderimi için, birbirlerine bağlı çalışan ve belirli bir sırayla kullanıması gereken üç adet yöntem sunmaktadır. Bunlar:

Mobildev COM’un mesaj gönderim paketlerinin önerilen boyutu 30.000 adettir.

addtosmsbasket yöntemi

addtosmsbasket yöntemi, gönderilmek istenen SMS paketinin hazırlanmasında kullanılır. Bu yöntemi her çağırışınızda parametre olarak belirtmiş olduğunuz GSM numarası ve mesaj içeriğini mevcut SMS paketi içerisine ekler.

Söz dizimi:

dtosmsbasket “mesaj”,”gsmno” şeklindedir.    

Bu yöntemde:
mesaj parametresi, SMS mesajı olarak gönderilmek istenen 160 karakterlik String değerini, gsmno parametresi, mesajın gönderileceği cep telefonu numarasını ifade etmektedir.

sendsms yöntemi

sendsms yöntemi, addtosmsbasket yöntemiyle oluşturulmuş SMS paketini parametre olarak belirtilen kullanıcı bilgileri ile Gateway’a göndermek için kullanılır.

Söz dizimi:

sendsms “UserName”,”PassWord”,”Originator”,”SendDate” şeklindedir.

Bu yöntemde:
UserName parametresi, Mobildev’de tanımlı kullanıcı adınızı,
PassWord parametresi, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi ifade etmektedir.

Not: UserName parametresine 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.

Originator parametresi, mesajın gönderildiği GSM numarasında gönderen kısmında çıkacak ifadeyi, SendDate parametresi, ggaayyyyssdd (GünAyYılSaatDakika) şeklinde gönderim zamanını ifade eder.

Eğer Originator parametresine herhangi bir değer girmezseniz kullanıcıya ait tanımlanmış olan ilk Originator bilgisi kullanılır.Eğer SendDate parametresine 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.

sendsms yöntemiyle gönderilen SMS paketi 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 SMS paketine ait TimerID bilgisi döner.
2. Hata oluşmuşsa: Bknz. Hata kodları  

clearsmsbasket yöntemi

clearsmsbasket yöntemi, addtosmsbasket yöntemiyle hazırlanmış olan paketi sendsms yöntemiyle gönderdikten sonra paket içeriğini temizlemek için kullanılır.

Uyarı: Mobildev COM Object çözümümüzü kullanarak Gateway’a ulaşan yazılım geliştiriciler, bir GSM numarsına aynı mesajın birden fazla gittiğini aynı SMS paketinin Gateway tarafından işlendiğini ve dolayısıyla kullanıcı hesaplarından, hesaplanan miktardan daha fazla kontör düştüğünü sıklıkla belirtmektedirler. Eğer clearsmsbasket yöntemini sendsms yönteminden hemen sonra çağırmazsanız SMS paket içeriği silinmeyecek ve bir sonraki sendsms yöntemi çağrıldığında aynı mesaj(lar) aynı GSM numaralarına tekrar yollanacaktır. Çok kritik bir önemi olan clearsmsbasket yöntemini sendsms yöntemini çağırdıktan hemen sonra çağırmanızı tavsiye ediyoruz.

Örnekte SMS gönderiminde kullanılan yöntemlerin hepsinin kullanım şekilleri ve sıraları gösterilmektedir.

Örnek: SMS gönderimi

Mobildev COM Object, gönderilen SMS mesajlarının raporlanması için iki çeşit raporlama yöntemi sunmaktadır:

Tarih bazında raporlama (getmsgstatustodate yöntemi)

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

Söz dizimi:

getmsgstatus “UserName”,”PassWord”,”FDate”,“LDate” şeklindedir.

Bu yöntemde:

UserName parametresi , Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametresi, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
FDate parametresi, raporun başlangıç tarihini (“Yıl-Ay-Gün” şeklinde),
LDate parametresi, raporun bitiş tarihini (“Yıl-Ay-Gün” şeklinde) ifade etmektedir.

Aşağıdaki örnekte getmsgstatustodate yöntemi gösterilmektedir.

Örnek: Tarih bazında raporlama için kullanılan getmsgstatustodate yöntemi

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

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

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

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

1234<32>905358838799<32>2<13>
1234<32>905428838799<32>3<13>
1234<32>905558838799<32>1<13>

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, <13> ENTER karakterini temsil etmektedir.

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

Gönderilen mesaj bazında raporlama (getmsgstatus yöntemi)

Gönderilen mesaj bazında raporlama,diğer adıyla TimerID bazında raporlama, bir SMS paketine ait mesaj gönderim hareketlerini raporlamada kullanılır.

Söz dizimi:

getmsgstatus “UserName”,”PassWord”,”TimerID”

Bu yöntemde:

UserName parametresi, Mobildev’de tanımlı olan kullanıcı adınızı,
PassWord parametresi, Mobildev’de tanımlı olan kullanıcı adınıza ait şifreyi,
TimerID parametresi, rapor almak istenilen SMS paketine ait TimerID bilgisini ifade etmektedir.

Aşağıdaki örnekte getmsgstatus yöntemi gösterilmektedir.

Örnek: getmsgstatus yöntemi

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

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

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

Örnek: Gönderilen mesaj bazında (TimerID) raporlama geri dönüş değeri

1234<32>905448838799<32>2<13>
1234<32>905378838799<32>3<13>
1234<32>905058838799<32>1<13>

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, <13> ENTER karakterini temsil etmektedir.

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