HTTP/S SMS API

Mobildev HTTP/HTTPS API, uygulama geliştiricilerin, çözümlerine SMS teknolojisini eklemeleri için, HTTP ya da HTTPS üzerinden Mobildev SMS Gateway’a ulaşmalarını sağlamak amacıyla geliştirilmiştir.

Yazılım geliştiriciler, Mobildev HTTP/HTTPS tarafından sunulan yöntemleri, bu belgede belirtilen şekilde kullanarak çağırırlar. Sunulan yöntemler HTTP API ve HTTPS API için de aynıdır. Farklı olan kısımları parametrelerin gönderildiği adreslerdir. Bunlar:

HTTP API için:
http://gateway.mobilus.net/gateway.asp

HTTPS API için:
https://secure.mobilus.net/sms/gateway.asp

şeklindedir.

Hazırladığınız SMS gönderim formlarının action parametresine yukarıdaki adreslerden size uygun olanını ekleyerek SMS gönderim işlemlerini yapabilirsiniz. Gönderim yapacağınız formun metot parametresinin değeri POST olmalıdır.

Gateway’a aşağıdaki parametreleri gönderirseniz Gateway’dan geri dönüş değeri olarak kredi ve Originator bilgisi alınır:

UserName: Mobildev’de tanımı kullanıcı adınız
Company: Bağlı bulunduğunuz kanal bilgisi
Password: Kullanıcı hesabınızla beraber tanımlanmış şifreniz
Action: HTTP/HTTPS API’nin hangi işlev için kullanıldığını belirten parametre değeri (Kullanıcı bilgileri kontrolü için bu değer “2” olmalıdır.)

Not: “Company” parametresi Mobildev’le son kullanıcı şeklinde çalışıyorsanız “mb1000” değerini, Bayi şeklinde çalışıyorsanız size tanımlı olan değeri alır.
Aşağıdaki örnekte kullanıcı bilgileri kontrolü için gerekli URL ifadesi gösterilmektedir.

Örnek: Kullanıcı bilgileri kontrolü için gerekli URL ifadesi

HTTP için:
http://gateway.mobilus.net/gateway.asp?username=gecici&company=mb1000&password=1234&action=2 

HTTPS için:
https://secure.mobilus.net/sms/gateway.asp? username=gecici&company=mb1000&password=1234&action=2 

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

Kullanıcı bilgileri kontrolüne ait URL’yi belirtildiği gibi çağırdığınızda Gateway’dan 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 alfanümerik karakterlerden oluşan (Türkçe ve &, <, > gibi özel karakterler içermeyen) bir ifade olabilir.

Gateway’a aşağıdaki parametreleri gönderirseniz Gateway’dan geri dönüş değeri olarak mesaj gönderim paketine ait mesaj kodu (TimerID) döner:

Username: Mobildev’de tanımı kullanıcı adınız
Company: Bağlı bulunduğunuz kanal bilgisi
Password: Kullanıcı hesabınızla beraber tanımlanmış şifreniz
Action: HTTP/HTTPS API’nin hangi işlev için kullanıldığını belirten parametre değeri (SMS gönderimi için bu değer “0” olmalıdır.)
Message: Göndereceğiniz mesaj metni. (Türkçe ve özel karakterler kullanılmadan, en fazla 160 karakter)
Numbers: Mesaj gönderilecek GSM numaraları
Originator: Mesajın gönderildiği GSM numarasında, gönderen kısmında çıkacak bilgi. Boş bırakılırsa kullanıcı adınıza tanımlanmış olan ilk (default) originator bilgisi kullanılır.
SDate: İleri tarihe gönderim için başlangıç tarihi. Boş bırakılırsa mesaj gönderim işlemi hemen başlar.

Aşağıdaki örnekte SMS gönderimi için gerekli URL ifadesi gösterilmektedir.

Örnek: SMS gönderimi için gerekli URL ifadesi

HTTP için:
http://gateway.mobilus.net/gateway.asp?
username=gecici&company=mb1000&password=1234&
action=0&message=Deneme&
numbers=5327654321,5427654321,55576543212 

HTTPS için:
https://secure.mobilus.net/sms/gateway.asp?
username=gecici&company=mb1000&password=1234&
action=0&message=Deneme&
numbers=5327654321,5427654321,55576543212 

SMS gönderimine ait URL’yi belirtildiği gibi çağırdığınızda Gateway’dan aşağıdaki geri dönüş değerlerini alırsınız:  

İşlem başarılıysa:
ID: 152132 şeklinde mesaj paketine ait mesaj kodu (TimerID)

Hata oluşmuşsa: Bknz. Hata Kodları

Gateway’a aşağıdaki parametreleri gönderirseniz Gateway’dan geri dönüş değeri olarak msgid parametresinde belirtmiş olduğunuz TimerID’ye sahip SMS paketinin gönderim raporu döner:

Username: Mobildev’de tanımı kullanıcı adınız
Company: Bağlı bulunduğunuz kanal bilgisi
Password: Kullanıcı hesabınızla beraber tanımlanmış şifreniz
Action: HTTP/HTTPS API’nin hangi işlev için kullanıldığını belirten parametre değeri (Raporlama için bu değer “1” olmalıdır.)
Msgid: Mesaj gönderim paketine ait mesaj kodu (TimerID)

Aşağıdaki örnekte raporlama için gerekli URL ifadesi gösterilmektedir.

Örnek: SMS gönderimi için gerekli URL ifadesi

HTTP için:
http://gateway.mobilus.net/gateway.asp?
username=gecici&company=mb1000&
password=1234&action=1&msgid=1234 

HTTPS için:
https://secure.mobilus.net/sms/gateway.asp?
username=gecici&company=mb1000&
password=1234&action=1&msgid=1234

Kullanıcı bilgileri kontrolüne ait URL’yi belirtildiği gibi çağırdığınızda Gateway’dan aşağıdaki geri dönüş değerlerini alırsınız:  

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

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

Örnek: 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ı