JETSMS Web Servis Kullanımı

Transkript

1 Doküman JetSMS-MMS Web Servis Kullanım Yardım Dokümanı Güncelleme Tarihi JETSMS Web Servis Kullanımı 1- ReportOriginator - Method 2- ReportQuota - Method 3- ReportSMS-MMS - Method 4- SendSMS-MMS - Method 5- SendMMSAdvanced - Method 6- SendTCKNSMS - Method 7- SendSMSToGroup - Method 8- SendTCKNSMSToGroup - Method 9- SendSMSAdvancedToGroup - Method 10- ReportGroups - Method 11- ReportGroupNumbers - Method 12- Optin - Method 13- OptinByTitles - Method 14- Optout - Method 15- OptoutByTitles - Method 16- Optout Link - Bilgi 17- SendMMS - Method 18- Hata Kodları - Bilgi 19- Chanells - Bilgi Web Servis kullanımı için metodların açıklamaları ve notları aşağıda bulabilirsiniz. URL : WSDL : Farklı alfabelerde (Kürtçe,Rusça,Çince vs)gönderim yapmak için aşağıdaki url ve wsdl kullanınız. URL : WSDL : 1- ReportOriginator Tanımlı ve onaylı mesaj başlıklarınızı öğrenebilirsiniz. a- Parametreler String array şeklinde onaylı mesaj başlıklarınızı döner Sayfa 1 / 10

2 ReportQuota Gönderilebilir SMS Adetlerinizi görebilirsiniz Gönderilebilir SMS adetlerinizi rakam olarak döner 2- ReportSMS Gönderdiğiniz SMS ler için rapor çekebilirsiniz. (Status = 1: Başarılı,2:Beklemede,3:Hatalı,4:Zaman Aşımı,6:Limitten dolayı gönderilememiş,5: Hepsi groupid Mesaj gönderilmiş ise 00 dan sonraki kısım ( vb. ) status 1: Başarılı,2:Beklemede,3:Hatalı,4:Zaman Aşımı,5: Hepsi ReportSMSResult tipinde bir sonuç döndürür Sayfa 2 / 10

3 3- SendSMS SMS gönderimlerinizi yapabilirsiniz. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) messages Mesaj metni (String array tipinde) Gsm Numaraları (String array tipinde) channel Birden fazla kanal tanımlı ise, hangi kanal üzerinden gönderileceği belirtilmelidir. (tckn sms için TC, vodafone sms için VD girilmeli.) Aksi halde belirtilemsine gerek yoktur. Blacklist-filter onlengthproblem Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. 4- SendTCKNSMS TCKN SMS gönderimlerinizi yapabilirsiniz. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) messages Mesaj metni (String array tipinde) TCKN Numaraları (String array tipinde) Sayfa 3 / 10

4 Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Blacklist-filter Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak onlengthproblem Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. 5- SendSMSAdvanced Wappush,Binary,Flash ve Unicode SMS gönderimlerinizi yapabilirsiniz. Bunun için SendSMS ten farklı olarak message-type ve message-header alanları bulunmaktadır. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) messages Mesaj metni (String array tipinde). WapPush-SMS ler için bu alana göndereceğiniz linkin URL ini yazmalısınız Gsm Numaraları (String array tipinde) message-type 0: Text-SMS, 1: Binary-SMS, 2: WapPush-SMS, 3: Flash-SMS message-header Sadece Binary-SMS ve WapPush-SMS te kullanmanız gerekir. En fazla 40 karakter uzunluğunda olmalıdır. channel Birden fazla kanal tanımlı ise, hangi kanal üzerinden gönderileceği belirtilmelidir. (tckn sms için TC, vodafone sms için VD girilmeli.) Aksi halde belirtilemsine gerek yoktur. Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Blacklist-filter Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak onlengthproblem Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. Sayfa 4 / 10

5 6- SendSMSToGroup Gruplarınıza sms gönderimi yapabilirsiniz. Sadece grup isimleri belirterek gruplarınız içindeki tüm numaralara sms gönderebilirsiniz. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) message Mesaj metni. groupinfotype Grup bilgisinin tipini beliritr. Grup ismi ya da grup id bilgisine göre işlem yapılacağını beirtir. group Grup bilgisi. Bir önceki parametredeki bilgiye göre id ya da grup ismi verilebilir.(string array tipinde) channel Birden fazla kanal tanımlı ise, hangi kanal üzerinden gönderileceği belirtilmelidir. (tckn sms için TC, vodafone sms için VD girilmeli.) Aksi halde belirtilemsine gerek yoktur. Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Blacklist-filter Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak onlengthproblem Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. 7- SendTCKNSMSToGroup Gruplarınıza tckn sms gönderimi yapabilirsiniz. Sadece grup isimleri belirterek gruplarınız içindeki tüm tckn numaralarına tckn sms gönderebilirsiniz. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) Sayfa 5 / 10

6 messages Mesaj metni (String array tipinde) TCKN Numaraları (String array tipinde) groupinfotype Grup bilgisinin tipini beliritr. Grup ismi ya da grup id bilgisine göre işlem yapılacağını beirtir. group Grup bilgisi. Bir önceki parametredeki bilgiye göre id ya da grup ismi verilebilir.(string array tipinde) Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Blacklist-filter Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak onlengthproblem Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. 8- SendSMSAdvancedToGroup Gruplarınıza Wappush,Binary,Flash ve Unicode SMS gönderimlerinizi yapabilirsiniz. Bunun için SendSMSToGroup tan farklı olarak message-type ve message-header alanları bulunmaktadır. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) messages Mesaj metni (String array tipinde). WapPush-SMS ler için bu alana göndereceğiniz linkin URL ini yazmalısınız Gsm Numaraları (String array tipinde) message-type 0: Text-SMS, 1: Binary-SMS, 2: WapPush-SMS, 3: Flash-SMS message-header Sadece Binary-SMS ve WapPush-SMS te kullanmanız gerekir. En fazla 40 karakter uzunluğunda olmalıdır. groupinfotype Grup bilgisinin tipini beliritr. Grup ismi ya da grup id bilgisine göre işlem yapılacağını beirtir. Sayfa 6 / 10

7 group exclusion-time-start exclusion-time-stop channel Blacklist-filter onlengthproblem Grup bilgisi. Bir önceki parametredeki bilgiye göre id ya da grup ismi verilebilir.(string array tipinde) Gönderilmesi istenmeyen zaman aralığı başlangıcı. Formatı hhmmss Gönderilmesi istenmeyen zaman aralığı bitişi. Formatı hhmmss Birden fazla kanal tanımlı ise, hangi kanal üzerinden gönderileceği belirtilmelidir. (tckn sms için TC, vodafone sms için VD girilmeli.) Aksi halde belirtilemsine gerek yoktur. Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak Mesajlarınızın içerinde, maksimum gönderilebilir uzunluğu aşan mesajlar varsa ne yapılacığını belirler. Default olark 0 değerindedir ve tüm mesajlar rejext edilir. 1 değeri sadece uzunluk problemi olan mesajları gönderime almaz, diğerleri gönderilir. 2 değeri ise, uzunluk problemi olsun olmasın tüm mesajları gönderir. 9- ReportGroups Tanımlı gruplarınızı öğrenebilirsiniz. a- Parametreler clsgroups tipinde bir nesne döner. 2 alanı mevcuttur. Groupname ve Groupid. Groupname grubunuzun ismini Groupid ise grubunuzun sistemdeki karşılığına denk gelen numaradır. 11- ReportGroupNumbers Gruplarınızdaki numaraları öğrenebilirsiniz. a- Parametreler groupinfotype Grup bilgisinin tipini beliritr. Grup ismi ya da grup id bilgisine göre işlem yapılacağını beirtir. group Grup bilgisi. Bir önceki parametredeki bilgiye göre id ya da grup ismi verilebilir.(string array tipinde) clsgroupinfo tipinde bir nesne döner. 6 alanı mevcuttur. Bu alanlar :Ad, Soyad, Not, GSM, GroupId, Grupname. GroupId grubunuzun sistemdeki karşılığına denk gelen numaradır. Diğer alanlar rehber bilgilerinize denk gelir. Sayfa 7 / 10

8 12- Optin Onaylı sms listesi bu method ile kaydedilir. Tüm originator lar için izin verilmiş olur. a- Parametreler msisdnlist Kaydedilecek GSM numaraları tek tek veya grup olarak burada listelenir. OptinResult tipinde bir nesne döner. 2 alanı mevcutturç ErrorCode ve ID alanlarıdır. Her iki alan String tipinde değer alır. 13- OptinByTitles Sadece seçilen originatorlar için kayıt olunur. Parametreler msisdnlist Kaydedilecek GSM numaraları tek tek veya grup olarak burada listelenir. optintitles Originator listesi <OptinByTitlesResult> tipinde bir nesne döner. 2 alanı mevcutturç ErrorCode ve ID alanlarıdır. Her iki alan String tipinde değer alır. 14- Optout Onaylı listeden GSM numaraları çıkarılır. Tüm originator lardan çıkarılır. Parametreler msisdnlist Kaydedilecek GSM numaraları tek tek veya grup olarak burada listelenir. < OptoutResult> tipinde bir nesne döner. 2 alanı mevcutturç ErrorCode ve ID alanlarıdır. Her iki alan String tipinde değer alır. 15- OptoutByTitles Sadece seçilen originator lardan kayıt çıkarılır. Parametreler msisdnlist Kaydedilecek GSM numaraları tek tek veya grup olarak burada listelenir. optintitles Originator listesi < OptoutByTitlesResult > tipinde bir nesne döner. 2 alanı mevcutturç ErrorCode ve ID alanlarıdır. Her iki alan String tipinde değer alır. Sayfa 8 / 10

9 16- Optout Link Mesaj metni içerisinde otomatik olarak optout-linki( ) verebilirsiniz. Kulanımı; mesaj metni içerisinde nereye optout linki eklemek istiyorsanız #optout# yazmanız yeterli olacaktır. Örnek kullanımı aşağıdaki gibidir: Gönderdiğiniz mesaj metni: Bu bir test mesajıdır. Duyuru listesinden çıkmak için #optout# linkini tıklayınız. Cep telefonunuza gelen mesaj: Bu bir test mesajıdır. Duyuru listesinden çıkmak için linkini tıklayınız. 17- SendMMS SMS gönderimlerinizi yapabilirsiniz. Cevap olarak eğer başarılı(errorcode = 00 ) ise ID ( ReportSMS metodunda group_id e karşılık gelir) döner. ( şeklinde) Gsm Numaraları (String array tipinde) subject MMS konu bilgisi. MMS in en başında görüntülenir. message MMS mesaj metni. Zorunlu bir alan değildir. mmscontentdatabase64 MMS olrak gönderilecek dosyanın base64 kodlanmış halidir. mmscontenttype MMS olrak gönderilecek dosyanın content type bilgisi. Örn: image/jpeg, video/mp4 gibi. channel Hangi kanal üzerinden gönderileceği belirtilmelidir. VDM,TRKCM veya AVEAM olabilir. Eğer sistemimizde, izinli veritabanınız mevcut ise ve izinli veritabanı kontrolü yapmak Blacklist-filter Eğer sistemimizde, BlacklistSms grubunuz mevcut ise ve karaliste kontrolü yapmak 18- Hata Kodları Oluşabilecek hata kodlarını aşağıdaki linkten görebilirsiniz Sayfa 9 / 10

10 19- Channels SMS veya MMS gödneriminde gönderim kanalını belirtmeye yarayan channel parametresinin alabilceği değerler aşağıdaki gibidir. KANAL VD YD VDO TC KB VFO VF VDM TRKC TRKCO TRKCT TRKCV TRKCW TRKCM TRKCAC AVEA AVEAO AVEAT AVEAV AVEAW AVEAM AÇIKLAMA VODAFONE YURTDISI VODAFONE OTP TCKN KKTC VODAFONE NET OTP VODAFONE NET VODAFONE MMS TURKCELL SMS TURKCELL OTP TURKCELL TCKNO TURKCELL VERGINO TURKCELL WAPPUSH TURKCELL MMS TURKCELL ANINDACEVAP TURK TELEKOM SMS TURK TELEKOM OTP TURK TELEKOM TCKN TURK TELEKOM VERGI NO TURK TELEKOM WAPPUSH TURK TELEKOM MMS Sayfa 10 / 10