TürkiyeSMS Toplu Sms Gateway API

TürkiyeSMS
Toplu Sms Gateway API
Document Version 2.0.0
İÇİNDEKİLER





Bir mesajın N numaraya gönderim metodu
N mesajın N numaraya gönderim metodu
İletim raporu alma
Originator ekleme
Kullanıcı kredisi Sorgulama
1. Bir mesajın N numaraya gönderim metodu :
XML YAPI :
<TOPLUSMS>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Şifre</SIFRE>
<ORIGINATOR>Gönderen</ORIGINATOR>
<GONDERIMTARIHI>Gönderim Tarihi</GONDERIMTARIHI>
<BITISTARIHI>Gönderim Bitiş Tarihi</BITISTARIHI>
<NUMARALAR>5331234567,5421234567</NUMARALAR>
<MESAJMETNI><![CDATA[Test Mesaji]]></MESAJMETNI>
<MESAJTIPI>1</MESAJTIPI>
</TOPLUSMS>
KULLANICI ADI : TürkiyeSMS tarafindan size verilen kullanıcı adı dır.
SIFRE : TürkiyeSMS tarafindan size verilen şifre dir.
ORIGINATOR : Gönderen kısmında görünecek olan max.11 karakter olabilen numerik
veya alfanumerik isimdir.ORIGINATOR alanı boş bırakılırsa sistemde kayıtlı olan
varsayılan originator esas alınarak sms gönderimi yapılır.
GONDERIMTARIHI : Mesajların kişilere ulaşmasını istediğiniz tarihtir.
yyyy-mm-dd hh:nn formatındadır.(ör:2012-03-20 13:00) Tarih yazılmazsa sistem
saatine göre hemen gitmeye başlar.
BITISTARIHI : Mesajların ulaşma işleminin son bulmasını istediğiniz tarihtir. yyyy-mmdd hh:nn formatındadır. Boş bırakıldığı takdirde mesajlar 24 saat süreyle ulaştırılmaya
çalışılır.
NUMARALAR : Mobil Telefon numarası yazılır. 5xxxxxxxxx formatında
olmalıdır.Numaralar birbirinden virgül (,) ile ayrılır.
MESAJMETNI : Max. 160 karakterli Türkçe karakter içermeyen mesaj metni yazılır.
Türkçe karakter kullanılır ise sistem karakterleri İngilizce karakterler ile düzelterek
gönderir.Mesaj metni boş olmamalıdır.
MESAJTIPI : Gönderilen mesajın tipini belirler.1 değerini alırsa mesaj telefonun mesaj
kutusuna düşer, 2 değerini alırsa mesaj telefonun ekranına bilgi mesajı olarak
görüntülenir.
 1 : Normal SMS
 2 : Flash SMS
Yukarıdaki XML Envelop ‘u http://gateway.turkiyesms.net/Gateways/Send/
adresine POST edildiğinde sistem size XML türünde cevap döner. Bu xml formatı
aşağıdaki gibidir
1: <?xml version="1.0" encoding="utf-8"?>
2: <Results>
3:
<Status> iletimin durumu bool tiptedir </Status>
4:
<Message> sistemin size verdiği cevap mesajı </Message>
5:
<Code> Başarılı ise SMSId, Başarısız ise hata kodu vermektedir
</Code>
6: </Results>
Örnek :
Burada 547 gönderilen mesajlarla ilgili server tarafından atanan işlem
numarasını gösterir.Bu numara daha sonra iletim raporları alma işleminde
kullanılacaktır.
HATA KODLARI
20
30
40
50
60
70
80
90
-1
: Mesaj metni veya Numaralar boş.
: Kullanıcı Adı veya Şifre Hatası.
: SMS iletilemedi.
: XML boş.
: Kredi yetersiz.
: Gönderim Tarihi mevcut tarihten küçük.
: Bitiş Tarihi sistem tarihten küçük.
: Tanımsız Originator.
: Sistem Hatası
2. N mesajın N numaraya gönderim metodu :
Mesajlar <MESAJLAR></MESAJLAR> tagları arasına yazılır. Mesajları
birbirinden ayırmak için “|” (pipe) kullanılır.
XML YAPI :
<TOPLUSMS>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Şifre</SIFRE>
<ORIGINATOR>Gönderen</ORIGINATOR>
<GONDERIMTARIHI>Gönderim Tarihi</GONDERIMTARIHI>
<BITISTARIHI>Gönderim Bitiş Tarihi</BITISTARIHI>
<NUMARALAR>5331234567,5421234567</NUMARALAR>
< MESAJMETNI ><![CDATA[Test Mesaji1|Test Mesaji2]]></
MESAJMETNI >
<MESAJTIPI>1</MESAJTIPI>
</TOPLUSMS>
Yukarıdaki XML Envelop ‘u http://gateway.turkiyesms.net/Gateways/Send/
adresine POST edildiğinde sistem size XML türünde cevap döner. Bu xml formatı
aşağıdaki gibidir
Burada 547 gönderilen mesajlarla ilgili server tarafından atanan işlem
numarasını gösterir.Bu numara daha sonra iletim raporları alma işleminde
kullanılacaktır.
HATA KODLARI
20
30
40
50
60
70
80
:
:
:
:
:
:
:
Mesaj metni veya Numaralar boş.
Kullanıcı Adı veya Şifre Hatası.
SMS iletilemedi.
XML boş.
Kredi yetersiz.
Gönderim Tarihi mevcut tarihten küçük.
Bitiş Tarihi sistem tarihten küçük.
90 : Tanımsız Originator.
-1 : Sistem Hatası
3. SMS İLETİM RAPORU ALMA :
<RAPOR>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Sifre</SIFRE>
<ISLEMNO>SMS Islem No</ISLEMNO>
</RAPOR>
ISLEMNO
: SMS GÖNDERİM işlemi sonucu dönen işlem numarasıdır.(ör:
123456 dönen sonucundaki 123456 numarasıdır.)
KULLANICIADI : TürkiyeSMS tarafından size verilen kullanıcı adı dır.
SIFRE: TürkiyeSMS tarafından size verilen kullanıcı şifresi dir.
Yukarıdaki XML Envelop ‘u
http://gateway.turkiyesms.net/Gateways/Reports/
edildiğinde ISLEMNO ‘ya ait sms iletim raporu alınır.
Status :
0
1
3
4
->
->
->
->
beklemede
başarılı
başarısız
süre aşımı
şeklinde olacaktır.
anlamına gelmektedir.
adresine POST
HATA KODLARI
30
40
50
60
:
:
:
:
Kullanıcı Adı/Şifre hatası.
ISLEMNO boş gönderilmiş.
XML boş.
Geçersiz ISLEMNO veya kullanıcıya ait böyle bir ISLEMNO mevcut degil.
4. ORIGINATOR EKLEME :
<EKLE>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Sifre</SIFRE>
<ORIGINATOR>GÖNDEREN İSMİ</ORIGINATOR>
</EKLE>
Yukarıdaki XML Envelop ‘u http://gateway.turkiyesms.net/Gateways/
OriginatorInsert/ adresine POST edildiğinde alınır.
HATA KODLARI :
20 : Originator boyut hatası.(Originator tanımı min. 2, max. 11 karakter
olmalıdır.)
30 : Kullanıcı Adı / Şifre hatası.
40 : Originator daha önce tanımlanmış.
50 : XML data boş gönderilmiş.
5. KULLANICI KREDİSİ SORGULAMA :
<KREDISORGU>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Sifre</SIFRE>
</KREDISORGU>
Yukarıdaki XML Envelop ‘u http://gateway.turkiyesms.net/Gateways/
Credit/ adresine POST edildiğinde aşağıdaki xml döner.
HATA KODLARI :
40 : Kullanıcı Adı / Şifre hatası.
50 : XML data boş gönderilmiş.
6. ORIGINATOR SORGULAMA :
<SORGU>
<KULLANICIADI>Kullanici Adi</KULLANICIADI>
<SIFRE>Sifre</SIFRE>
</SORGU>
Yukarıdaki XML Envelop ‘u http://gateway.turkiyesms.net/Gateways/
OriginatorLists/ adresine POST edildiğinde aşağıdaki xml döner.
HATA KODLARI :
40 : Kullanıcı Şifresi hatalı.
50 : XML data boş gönderilmiş.