3G SMS & MMS GateWay Xml Interface 2008 Bu dökümanlar üzerinde değişiklik olma durumu mevcuttur. Elinizdeki dökümanın en son versiyon olduğunu www.3gbilisim.com adresinden kontrol edin. Yeni Nesil Teknolojiler
TOPLU SMS GÖNDERME,CONCAT SMS, BINARY SMS, MMS, İLETİM RAPORU ALMA 2
3G SMS GateWay XML Arayüzü 3G Bilişim, yazılım geliştiren firmaların kullanılabilecekleri iki çeşit sms gönderme yöntemi sağlamaktadır. Aynı mesajın çok numaraya gönderilmesi, Farklı mesajların farklı numaralara gönderilmesi Her iki yöntemde de mesajlar XML Envelope u olarak gönderilmekte ve aynı raporlama uygulaması ile sonuçları alınmaktadır. Post edilen ASP ve DLL uygulamaları, 128 bit Thawte SSL sertifikası ile desteklenmiştir. Post edilme esnasında sertifika ile ilgili bir sıkıntı yaşanması durumunda; https yerine http metodu da kullanılabilir. 3G SMS GateWay den dönen değerler 00 Kullanıcı Bilgileri Boş 01 Kullanıcı Bilgileri Hatalı 02 Hesap Kapalı 03 Kontör Hatası 04 Bayi Kodunuz Hatalı 05 Originator Bilginiz Hatalı 06 Yapılan İşlem İçin Yetkiniz Yok 10 Geçersiz IP Adresi 14 Mesaj Metni Girilmemiş 15 GSM Numarası Girilmemiş 20 Rapor Hazır Değil 27 Aylık Atım Limitiniz Yetersiz 100 XML Hatası 3
AYNI MESAJIN ÇOK NUMARAYA GÖNDERILMESI Bu yöntemde amaç, tek bir mesaj metninin farklı numaralara yollanabilmesidir. Bu yöntemde kullanılacak olan XML formatı aşağıdaki gibidir. XML paketi içerisinde yukarıda örneği verilen response bilgileri kullanılmıştır. Sadece version bilgisi xml paketinin, hangi programdan ve hangi versiondan geldiği bilgilerinin arşivlerde tutulması amacıyla alınacaktır. http://gateway.3gmesaj.com/sendsmsmany.aspx <?xml version="1.0" encoding="iso-8859-9"?> <MainmsgBody xmlns:sql='urn:schemas-microsoft-com:xml-sql' xmlns:updg='urn:schemas-microsoftcom:xml-updategram'> <UserName>test</UserName> <PassWord> pass</password> <CompanyCode >Bayi Kodu</CompanyCode> <Type>1</Type> <Developer></Developer> <Originator>TEST</Originator > <Version>xVer.4.0</Version> <Mesgbody>test mesajıdır</mesgbody> <Numbers>905492683537, 905059683575, 905392455483</Numbers> </MainmsgBody> 4
Xml Envelop Açıklamaları Username Password CompanyCode Mesgbody Bayiniz tarafından sağlanacak kullanıcı adı Kullanıcı Şifreniz Bayiniz Tarafınızdan Verilen Kod 160 karakterden oluşan mesaj metni Developer Version Originator Numbers SDate Yazılım firması tarafından en çok 15 karakter verilir. Gönderici Başalığı En 3 En Fazla 11 karakter Türkçe Harf Kullanılmaz Mesaj gönderilecek numaralar herbir numara ülke kodunu da içeren uluslararası formatta olmalı ve numaralar arasında ayraç olarak virgül kullanılmalı, ülke ve operator kodları yukarıdaki örnekte olduğu gibi karakteri ile birbirinden ayrılmalıdır. Ülke kodunun verilmemesi durumunda (5329808070 gibi), ülke kodu 90 (Türkiye) olarak değerlemeye alınır. Mesajın gönderilmeye başlanacağı tarihi gösterir ddmmyyyyhhmm formatındadır. Bu değer belirtilmemişse mesaj hemen yollanır. EDate Mesajın gönderilme işleminin sonlandırılacağı zamandır. Bu tarihten sonra mesaj gönderme işlemi durdurulacak ve beklemeye alınan mesajlar zaman aşımı (timeout) olacaktır. Not: Sdate ve Edate bilgisi boş bırakıldığında mesajlar hemen gönderilmeye başlanır. Tarih bilgileri Post işleminin ardından aşağıdaki gibi bir response alınacaktır. ID:174521 Eğer serverdan yukarıdaki örnekte olduğu gibi bir bilgi dönmüşse mesajlar başarılı bir şekilde server a iletilmiş anlamına gelir. ddmmyyyyhhmm formatındadır. 5
FARKLI MESAJLARIN FARKLI NUMARALARA YOLLANMASI Bu yöntemde amaç farklı numalara farklı mesajların aynı anda yollanabilmesidir. Örneğin herbir müşteriye farklı ödeme tutarlarının gönderilmesi gibi. Bu yöntemde kullanılacak XML Envelope ve url adresi aşağıdaki gibidir http://gateway.3gmesaj.com/sendsmsmulti.aspx <?xml version="1.0" encoding="iso-8859-9"?> <MainmsgBody xmlns:sql='urn:schemas-microsoft-com:xml-sql' xmlns:updg='urn:schemas-microsoftcom:xml-updategram'> <UserName>test</UserName> <PassWord> pass</password> <CompanyCode >Bayi Kodu</CompanyCode> <Type>1</Type> <Developer>1521</Developer> <Version>xVer.2.0</Version> <Originator>TEST</Originator> <Messages> <Message> <Mesgbody> ODEME TUTARINIZ 123 YTL DIR.</Mesgbody> <Number>905399809080</Number> </Message> <Message> <Msgbody> ODEME TUTARINIZ 225 YTL DIR.</Msgbody> <Number>905499807050</Number> </Message> </Messages> </MainmsgBody> 6
Xml Envelop Açıklamaları Username Password CompanyCode Mesgbody Bayiniz tarafından sağlanacak kullanıcı adı Kullanıcı Şifreniz Bayiniz Tarafınızdan Verilen Kod 160 karakterden oluşan mesaj metni Developer Version Originator Numbers SDate Yazılım firması tarafından en çok 15 karakter verilir. Gönderici Başalığı En 3 En Fazla 11 karakter Türkçe Harf Kullanılmaz Mesaj gönderilecek numaralar herbir numara ülke kodunu da içeren uluslararası formatta olmalı ve numaralar arasında ayraç olarak virgül kullanılmalı, ülke ve operator kodları yukarıdaki örnekte olduğu gibi karakteri ile birbirinden ayrılmalıdır. Ülke kodunun verilmemesi durumunda (5329808070 gibi), ülke kodu 90 (Türkiye) olarak değerlemeye alınır. Mesajın gönderilmeye başlanacağı tarihi gösterir ddmmyyyyhhmm formatındadır. Bu değer belirtilmemişse mesaj hemen yollanır. EDate Mesajın gönderilme işleminin sonlandırılacağı zamandır. Bu tarihten sonra mesaj gönderme işlemi durdurulacak ve beklemeye alınan mesajlar zaman aşımı (timeout) olacaktır. NOT: SDATE VE EDATE BİLGİSİ BOŞ BIRAKILDIĞINDA MESAJLAR HEMEN GÖNDERİLMEYE BAŞLANIR. TARİH BİLGİLERİ DDMMYYYYHHMM FORMATINDADIR. Post işleminin ardından aşağıdaki gibi bir response alınacaktır. ID:174521 Eğer serverdan yukarıdaki örnekte olduğu gibi bir bilgi dönmüşse mesajlar başarılı bir şekilde server a iletilmiş anlamına gelir. 7
MMS GÖNDERIM ADRESLERI MMS gönderimi için Firmamızla irtibata geçtikten sonra edineceğiniz COM+ Objelerini Hesap tanımlamanız yapıldıktan sonra aşağıdaki adresler ile birlikte kullanabilirsiniz. TOPLU MMS http://gateway.3gmesaj.com/sendmmsmany.aspx ÖZEL TOPLU MMS http://gateway.3gmesaj.com/sendmmsmulti.aspx WAP-PUSH SMS http://gateway.3gmesaj.com/wappushmany.aspx Delphi Örnek : mmsobj := CreateOleObject( 'BULKMESSAGE.MMS' ) as IMMS; mmsobj.open; mmsobj.proxy:=false; response:= mmsobj.getauth (user.text,pas.text,kod) ; strguid:=mmsobj.guid ; strcredit:=mmsobj.credit; strtype:=mmsobj.usertype ; stroriginlist:=mmsobj.originlist; strerror:=mmsobj.error; mmsobj.gsmlist:='905358529796,905399804550'; mmsobj.originator:='levent'; mmsobj.msgtext:='mms deneme'; mmsobj.sdate:=''; mmsobj.edate:=''; res:=ammsobj.addmmsfilemessage ("\temp\33.gif","","dunya.gif","","","1") res:=mmsobj.addmmsfilemessage ("\temp\neredesin Sen.mid","","","Neredesin Sen","","2") response:=mmsobj.sendmms('','',''); 8
ASP Örnek : Set ASPObj = Server.CreateObject("BULKMESSAGE.MMS") ASPObj.open ASPObj.proxy=false ASPObj.proxyserver="" ASPObj.proxyport=0 ASPObj.ProxyUsername="" ASPObj.ProxyPassword="" response = ASPObj.getauth (user,pass,kod) strguid=aspobj.guid strcredit=aspobj.credit strtype=aspobj.usertype stroriginlist=aspobj.originlist res=aspobj.addmmsfilemessage ("\temp\33.gif","","dunya.gif","","","1") res=aspobj.addmmsfilemessage ("\temp\neredesin Sen.mid","","","Neredesin Sen","","2")... response=aspobj.sendmms("","","") DETAYLI BİLGİ İÇİN FİRMAMIZLA İLETİŞİME GEÇİN. 9
CONCAT MESAJ Concat Many http://gateway.3gmesaj.com/sendsmsmany.aspx <?xml version='1.0' encoding='iso-8859-9'?> <MainmsgBody> <UserName></UserName> <PassWord></PassWord> <CompanyCode></CompanyCode> <Type>5</Type> <Originator><![CDATA[4751]]></Originator> <Version>Sms 5.0</Version> <Developer>Comp</Developer> <Mesgbody><![CDATA[test mesaj 1 aaaaaaa aaaaaaaaaaaaaa aaaaaaa aaaaaaaaaaaaaaaa aaaaaaaaaaaa aaaaaa aaaaaaaaaaaaaa aaaaaaaaaaaaaa aaaaaaaa aaaaaaaa aaaaaaa aaaads1 Fff ffffffff fffffff ffff f]]></mesgbody> <Numbers>90532.</Numbers> </MainmsgBody> 10
<![CDATA[testaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaarrrrrtttttttttttttttttttttttttttttttttttttttttttttttttttttttttttttt ttttttttttttttttttttttttttttttttttttttttttttttttttt]]></mesgbody> Concat Multi http://gateway.3gmesaj.com/sendsmsmulti.aspx <?xml version='1.0' encoding='iso-8859-9'?> <MainmsgBody> <UserName></UserName> <PassWord></PassWord> <CompanyCode></CompanyCode> <Type>5</Type> <Originator><![CDATA[4751]]></Originator> <Version>Sms 5.0</Version> <Developer>compy</Developer> <Messages> <Message> <Mesgbody><![CDATA[testaaaaa aaaaaaaaa aaaaaaaaaaaa aaaaaaaaaaaarrrrrt tttttttttttttttttt ttttttttttttt ttttttttttttttttt ttttttttttttttttt ttttttttttttt tttttttttttttttt tttttttttttttttttt]]></mesgbody> <Number>90539999999 </Number> </Message> <Message> <Mesgbody> <![CDATA[testaaaaa aaaaaaaaa aaaaaaaaaaaa aaaaaaaaaaaarrrrrt tttttttttttttttttt ttttttttttttt ttttttttttttttttt ttttttttttttttttt ttttttttttttt tttttttttttttttt tttttttttttttttttt]]></mesgbody> <Number></Number> </Message> <Message> 3G <Mesgbody> Tasarım Bilişim Teknolojileri Danışmanlık Elektronik İletişim Hiz. İth. ve İhr. Ltd. Şti. 11
TOPLU BINARY SMS http://gateway.3gmesaj.com/sendbinarymany.aspx <?xml version="1.0" encoding="iso-8859-9"?> <MainmsgBody xmlns:sql='urn:schemas-microsoft-com:xml-sql' xmlns:updg='urn:schemas-microsoftcom:xml-updategram'> <UserName>test</UserName> <PassWord> pass</password> <CompanyCode >Bayi Kodu</CompanyCode> <XSER>xser</SER> <Type>1</ Type > <Developer></Developer> <Originator>TEST</Originator > <Version>xVer.4.0</Version> <Mesgbody>test mesajıdır</mesgbody> <Numbers>905492683537, 905059683575, 905392455483</Numbers> </MainmsgBody> 12
ÖZEL BINARY SMS http://gateway.3gmesaj.com/sendbinarymulti.aspx <?xml version="1.0" encoding="iso-8859-9"?> <MainmsgBody xmlns:sql='urn:schemas-microsoft-com:xml-sql' xmlns:updg='urn:schemas-microsoftcom:xml-updategram'> <UserName>test</UserName> <PassWord> pass</password> <CompanyCode >Bayi Kodu</CompanyCode> <XSER>xser</SER> <Type>1</ Type > <Developer></Developer> <Originator>TEST</Originator > <Version>xVer.4.0</Version> <Mesgbody>test mesajıdır</mesgbody> <Numbers>905492683537, 905059683575, 905392455483</Numbers> </MainmsgBody> 13
Turkcell kullanan NOKIA telefonlar için Logo <?xml version='1.0' encoding='iso-8859-9'?> <MainmsgBody> <UserName></UserName> <PassWord></PassWord> <CompanyCode></CompanyCode> <Type>1</Type> <XSER>010706050415820000</XSER> <Originator><![CDATA[4751]]></Originator> <Version>Sms 5.0</Version> <Developer>Comp</Developer> <Mesgbody><![CDATA[82F61000480E0100000000000000000000000000000000000000000000000000 00003CF079E1E7879E0F3C4308861218486110C24008801200480110024008801200480110024008801 2004801100220]]></Mesgbody> <Numbers>905326670714</Numbers> </MainmsgBody> 14
Melodi <?xml version='1.0' encoding='iso-8859-9'?> <MainmsgBody> <UserName> </UserName> <PassWord> </PassWord> <CompanyCode></CompanyCode> <Type>1</Type> <XSER>010706050415811581</XSER> <Originator><![CDATA[4751]]></Originator> <Version>Sms 5.0</Version> <Developer>Comp</Developer> <Mesgbody><![CDATA[024A3A44C804018D1CCAEA374416AA8C44C54CC0CB0C50C50C54B50C40C50C C4CC4DD0DD164624624A84AA460A369591AA8DD4CD0CB0CD0C44C30C30C40CD4C54B54A30B50C4]] ></Mesgbody> <Numbers>90532 </Numbers> </MainmsgBody> 15
vcard <?xml version='1.0' encoding='iso-8859-9'?> <MainmsgBody> <UserName>t</UserName> <PassWord> </PassWord> <CompanyCode>1</CompanyCode> <Type>1</Type> <XSER>010706050423F40000</XSER> <Originator><![CDATA[4751]]></Originator> <Version>Sms 5.0</Version> <Developer>Comp</Developer> <Mesgbody><![CDATA[424547494E3A56434152440D0A4E3A4365703B4C6576656E740D0A54454C3B5 05245463B564F4943453A3930333132343636333331380D0A454E443A5643415244]]></Mesgbody> <Numbers>90532..</Numbers> </MainmsgBody> 16
Post işleminin ardından gelebilecek hata kodları ve karşılıkları 00 Bilgiler Boş 01 Kullanıcı adı yada şifresi hatalı 04 Developer Yanlış 05 Hatalı Originator 14 Mesaj Metni Girilmemiş 15 Gsm Numarası Girilmemiş 100 Xml Hatası 22 Aylık Limit adedi girilmemiş 27 Aylık Limit Doldurulmuş 03 Kontör Hatası 17
RAPOR ALMA DETAY RAPOR Her bir paketin detay raporunu almak için aşağıda verilen XML Envelop un Aşağıdaki adrese POST edilmesi gerekmektedir. http://gateway.3gmesaj.com/report.aspx <ReportMain> <UserName> UserName </UserName> <PassWord> PassWord </PassWord> <CompanyCode >Bayi Kodu</CompanyCode> <Msgid> Msgid </Msgid> <Type> Type</Type> <Delm> </Delm> </ReportMain> Xml Envelop Açıklamaları UserName PassWord Msgid RType Delimiter Kullanıcı adı Kullanıcı şifresi Paketin işleme alındığı Tarih/Saat İstenilen Rapor Tipi (1 İletildi, 2 Beklemede, 3 Hatalı, 4 Zaman Aşımı) Type Alanı Girilmediği Durumlarda Toplam Rapor Görütülenir.(iletilen,Beklemede,Hatalı ve zaman Aşımları Birlikte Görüntülenir.) Type alanı Boş girildiği durumlarda dikkate alınır Default değeri ; dir. Numara Durum Kodları 1 Bekleyen Numaralar (Kullanımda ancak kapsama alanı dışında ya da telefon kapalı) 2 İletilen Numaralar 3 Sistem Hatası (bu numara kullanımda değil yada servis dışı) 18
4 İletilememesinden dolayı zaman aşımı (XML içinde SDATE ve EDATE değerleri verilmediği takdirde default 24 saattir.) Hata Kodları 00 Hatalı kullanıcı Adı yada şifresi 01 Hatalı kullanıcı Adı yada şifresi 20 Özet Raporda; verilen dönem için atış bulunamadı 21 Detay Raporda; verilen parametreler için rapor bulunamadı yada rapor henüz hazır değil Type alanı boş girildiği durumlarda Ekran çıktısı aşağıdaki gibidir 2141 90505...1 2 021107141318 2141 90505 2 2 021107141251 2141 90535 3 2 021107141317 2141 90532 4 2 021107184515 2141 90532 5 2 021107184515 2141 90532 6 2 021107184516 2141 90532 7 3 2141 90535 8 4 2141 90533 9 1 19
ORIGINATOR SORGULAMA Kullanıcı kullanabileceği Originator ları bir tek istekle sorgulayabilir. Bunun için aşağıda verilen XML Envelop un Aşağıdaki adrese POST edilmesi gerekmektedir. http://gateway.3gmesaj.com/queryorigin.aspx <OriginMain> <UserName>Company Username</UserName> <PassWord>Company Password</PassWord> <CompanyCode >Bayi Kodu</CompanyCode> <User>User</User> <Originator>DENEME</Originator> </OriginMain> RESPONSE YAPISI OK (İlk Satır Başarılı Durum Kontrolu) ORIGINATOR1 ORIGINATOR2 Dönen Hata kodlar 01 Hatalı Kullanıcı Adı yada Şifresi 100 XML Hatası 20
KREDI SORGULAMA Kullanıcı mevcut kredisini bir tek istekle sorgulayabilir. Bunun için aşağıda verilen XML Envelop un Aşağıdaki adrese POST edilmesi gerekmektedir. http://gateway.3gmesaj.com/querycredit.aspx <Main> <UserName>Username</UserName> <PassWord> Password</PassWord> <CompanyCode >Bayi Kodu</CompanyCode> </Main> RESPONSE YAPISI 1250 20081230 1.Satır: Kredi Mıktarı. 2. Satır: Expire Değeri.yyyymmdd formatında Dönen Hata kodları 00 Kullanıcı Bilgileri Boş 01 Kullanıcı Bilgileri Hatalı 02 Hesap Kapalı 03 Kontör Hatası 06 Bu İşlem İçin Yetkiniz Yok 10 Geçersiz IP Adresi 100 XML Hatası 21