Xml Arayüzleri. 6. Sms To Multisenders (Farklı Mesajların Farklı Numaralara Yollanması)

Transkript

1 Xml Arayüzleri version 2.5 Son güncelleme Tarihi : Eklenen Yenilikler : - Concatenated (Uzun Mesaj) eklendi. - Wap Push gönderimi eklendi. Concat gönderim destekleniyor. 1. Genel Bilgiler 2. Uyarılar ve Öneriler 3. Alan Açıklamaları 4. Mesaj Tipleri 5. SMS To Many (Aynı Mesajın Çok Numaraya Yollanması) 6. Sms To Multisenders (Farklı Mesajların Farklı Numaralara Yollanması) 7. Report By Id ( Belirli bir İşlemin İletim Raporu ) 8. GetCredit ( Originator ve Krediyi Aynı Anda Sorgulama ) 9. Cancel Job ( İleri Tarihli bir gönderimin iptal edilmesi ) 10. CheckDate ( Güncel Sistem Saatinin öğrenilmesi )

2 1. Genel Bilgiler 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 yollanması, Farklı mesajların farklı numaralara yollanması İki yöntemde de mesajlar, ve diğer işlemler XML Envelop u olarak gönderilmektedir. Oluşturulacak tüm İstekler aşağıdaki adrese Post edilmelidir. yada secure bağlantı için Genel Hata Kodları: 20 : Bilinmeyen hata 21 : Yanlış XML formatı 22 : Kullanıcı aktif değil 23 : Kullanıcı zaman aşımı

3 2. Uyarılar ve Öneriler - Uzun(Concatenated) Mesaj göndermek isteyen kullanıcılar, Concat parametresini "1" olarak ayarlamalıdır. - Uzun Mesajların raporlarında, 1 numaraya ait mesajların herbiri için kayıt dönülür. - &, < gibi XML in özel karakterlerini gönderebilmeniz için bu karakterleri aşağıdaki gibi encode etmeniz gerekmektedir. < < less than > >greater than & & ampersand ' apostrophe " quotation mark - Yurtdışına sms gönderiminde Tel numaralarının +49******** formatında olmasına dikkat edilmelidir.sms gönderilecek ülkedeki ülke kodu + prefix + telno 12 karakterden küçük olması halinde de yine +35********* şeklindeki bir format kullanılarak sms gönderimi yapılabilir. - Hem SmsToMany, hem de SmsMultiSenders gönderimler sırasında numaralar , ya da şeklinde verilebilir.ancak rapor alındığında bütün numaralar şeklinde görünecektir. Yapılacak kodlamalarda bu durum dikkate alınmalıdır.

4 3. Alan Açıklamaları Xml İsteklerinde kullanılan Nodelara ait açıklamalar aşağıdaki gibidir. PlatformID : Yetkili tarafından sağlanacak PlatformID. Yetkili tarafından aksi söylenmedikçe 1 olarak girilmelidir. ChannelCode : Yetkili tarafından sağlanacak Kanal Kodu. UserName : Yetkili tarafından sağlanacak kullanıcı adı. Password : Yetkili tarafından sağlanacak kullanıcı şifresi. Command : Her işleme göre farklılık gösteren İşlem kodu. Alabileceği değerler aşağıdaki gibidir. Smstomany: 0 Smstomultisenders: 1 Reportbydate: 2 ReportbyId: 3 Canceljob: 4 Checkdate: 5 Getcredit: 6 Mesgbody : Type kısmında belirtilen formata göre oluşturulacak mesaj metni. MesajTipine göre Mesgbody'nin oluşturulması ile ilgili açıklamaları Mesaj Tipleri kısmına bulabilirsiniz. Numbers : Smstomany, yani 1 mesaj metninin birden fazla numaraya gönderilmesinde kullanılır. Numaralar , veya şeklinde olabilir ve numaralar arasında ayraç olarak virgül kullanılmalıdır. Type : Mesajın formatını belirlemek için kullanılacaktır. Ayrıntılı açıklamaları Mesaj Tipleri kısmına bulabilirsiniz. Alacağı değerler. Text SMS : 1 Wap-Push : 5

5 SDate : Mesajın gönderilmeye başlanacağı tarihi gösterir ddmmyyyyhhmm formatındadır. Bu değer belirtilmemişse mesaj hemen yollanır. Server tarihinden eski bir tarihe gönderilmeye çalışılırsa Mesajlar Hemen gidecektir. EDate : Mesajın gönderim işleminin biteceği tarihi gösterir ddmmmyyyhhmm formatındadır.. Hiçbir değer girilmemişse mesaj 24 saat içerisinde gönderilmeye devam edilir. End Date min. 90 dakika olmalıdır. 90 dakikadan küçük EndDate'lerde otomatik olarak 90 dakika ayarlanır. 24 saatten büyük EndDate ayarlamasında ise otomatik olarak 24 saat olarak ayarlanır. End Date her zaman Send Date ten büyük bir tarih olmalıdır. Bu durumda End Date, Send Date e 24 saat eklenerek uygulanır. End Date, şu anki tarihten küçük bir tarih olmamalıdır. Bu durumda End Date, Send Date e 24 saat eklenerek uygulanır. Originator : Mesaj gönderilirken kullanılacak originator seçilebilir. Boş ise default olan originator kullanır. Concat : Gelen istekte, Mesaj Tipine ait 1 mesajda gönderilemeyecek İçerik var ise, bunu otomatik olarak 1 den fazla mesaj olarak göndermesi için gerekli parametredir. Mesela 160 karakterlik Text Sms gönderilirken, Mesgbody alanına 160 tan fazla içerik yazılırsa ve Concat parametresi 1 olarak ayarlanırsa Mesajlar aboneye tek bir mesaj olarak ulaşacak fakat aslında birden fazla mesajın birleştirilerek gönderilmiş olacaktır. Alacağı değerler. 0 : Mesajlar uzun olarak gönderilmesin. 1 : Mesajlar uzun olarak gönderilsin.

6 4. Mesaj Tipleri 1.Text (ASCII 160 karakter): Xml isteğinde Type Node u 1 olmalıdır. Maximum uzunluk değerleri her mesaj için. Normal : 160 karakter Concat : 153 karakter Mesgbody Node'una String değer olarak yazılır. 2. WapPush : Xml isteğinde Type Node u 5 olmalıdır. Mesgbody Node'unda ayrı bir Xml yapısı olarak girilir.yapı aşağıdaki gibidir. <Mesgbody> <Indicator></Indicator> <URL></URL> </Mesgbody> Indicator : Mesaj açıklaması olarak yazılacak kısım URL : Adres bilgisi. Mutlaka aşağıdakilerden bir tanesi ile başlamalıdır

7 5. SMS To Many (Aynı Mesajın Çok Numaraya Yollanması) Bu yöntemde amaç tek bir mesaj metninin farklı numaralara yollanabilmesidir. Bu yöntemde kullanılacak olan XML formatı aşağıdaki gibidir: <MainmsgBody> <Command>0</Command> <PlatformID>1</PlatformID> <UserName>username</UserName> <PassWord>password</PassWord> <ChannelCode>channelcode</ChannelCode> <Mesgbody> test mesajıdır </Mesgbody> <Numbers> , </Numbers> <Type>1</Type> <Originator></Originator> <SDate></SDate> <EDate></EDate> <Concat><Concat> </MainmsgBody> Bu XML POST edildiğinde responsetext olarak bir string dönülür. Bu string gönderilen mesajlar için bir numara içerir. Örnek: ID: Burada 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. Başarılı Durum : ID: : SMS Gönderimi için dosya kabul edildi.

8 Hata Kodları : 01 : Username/PassWord yanlış girilmiş. 02 : Kredisi yeterli değil. 03 : Geçersiz içerik. 04 : Bilinmeyen SMS Tipi 05 : Yanlış Originator seçimi yapılmış. 06 : Mesaj metni yada numaralar boş girilmiş. 07 : İçerik uzun fakat Concat özelliği ayarlanmadığından mesaj birleştirilemiyor. 08 : Kullanıcının mesaj göndereceği gateway tanımlı değil veya şu anda çalışmıyor. 09 : Yanlış Tarih formatı, Tarihler ddmmyyyyhhmm formatında olmalıdır. 6. Sms To Multisenders (Farklı Mesajların Farklı Numaralara Yollanması) 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 Envelopu aşağıdaki gibidir: <MainmsgBody> <Command>1</Command> <PlatformID>1</PlatformID> <UserName>username</UserName> <ChannelCode> channelcode </ChannelCode> <PassWord> password</password> <Messages> <Message> <Mesgbody>SAYIN OZAN ÇETİN, BORCUNUZ 45 YTL DİR.</Mesgbody> <Number> </Number> </Message> <Message>

9 <Mesgbody> SAYIN HAKAN GÖK, BORCUNUZ 67 YTL DİR.</Mesgbody> <Number> </Number> </Message> </Messages> <Type>1</Type> <Originator></Originator> <SDate> </SDate> <EDate> </EDate> </MainmsgBody> Bu XML POST edildiğinde responsetext olarak bir string dönülür. Bu string gönderilen mesajlar için bir numara içerir. Örnek: ID: Burada 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. Başarılı Durum : ID: : SMS Gönderimi için dosya kabul edildi. Hata Kodları : 01 : Username/PassWord yanlış girilmiş. 02 : Kredisi yeterli değil. 03 : Geçersiz içerik. 04 : Bilinmeyen SMS Tipi 05 : Yanlış Originator seçimi yapılmış. 06 : Mesaj metni yada numaralar boş girilmiş. 07 : İçerik uzun fakat Concat özelliği ayarlanmadığından mesaj birleştirilemiyor. 08 : Kullanıcının mesaj göndereceği gateway tanımlı değil veya şu anda çalışmıyor. 09 : Yanlış Tarih formatı, Tarihler ddmmyyyyhhmm formatında olmalıdır.

10 7. Report By Id ( Belirli bir İşlemin İletim Raporu ) Mesaj gönderme işlemi başarıyla tamamlandıktan sonra gönderilen mesajların ulaşıp ulaşmadığına ilişkin iletim raporu alabilme işlemi aşağıdaki XML Envelop u POST edilerek gerçekleştirilebilir. <MainReportRoot> <Command>3</Command> <PlatformID>1</PlatformID> <UserName>username</UserName> <ChannelCode>channelcode</ChannelCode> <PassWord>password</PassWord> <MsgID>123456<MsgID> </MainReportRoot> Yukardaki XML Envelop u adresine POST edildiğinde XML responsetext aşağıdaki gibi olacaktır. GsmNo gönderimde 0543** veya 543** formatlarında gönderilse dahi raporlarda 90543** şeklinde alınacaktır. Başarılı Durum :

11 1.Sütun : SMS gönderilen numara. 2.Sütun : SMS in iletim durumu.(status) 3 : delivered ( Başarı ile iletilmiş) 5 : rejected ( İptal olan veya Gsm No formatına uygun olmayan numaralar) 6 : Pending (İşlemde olan ve gönderilmeye çalışılan numaralar) 9 : expired ( Geçerlilik Süresi bitene kadar gönderilmeye çalışılmış fakat, başarılı olamamış numaralar) 3.Sütun : Gönderilen SMS in Tipi. Hata Kodları : 01 : Username/PassWord yanlış girilmiş. 02 : UserName'e ait, verilen ID numarali bir işlem bulunamadi. 03 : ID girilmemiş veya genel bir hata oluştu. 04 : İşlem başarısız olmuştur.(multisenders gönderim ise mesaj metinleri yada numaralar boştur) 05 : Verilen ID li işlem şuanda yazılıyor-filtreleniyor veya gönderiliyor. Bu işleme ait SMS bulunamadı. 07 : Verilen ID li işlem a ait SMS bulunamadı. Yani boş bir işlem. 08 : İşlem kullanıcı tarafından iptal edilmiş. 8. Get Credit ( Originator ve Krediyi Aynı Anda Sorgulama ) Kullanıcı mevcut kredisini ve kullanabileceği Originator ları bir tek istekle sorgulayabilir. <MainReportRoot> <Command>6</Command> <PlatformID>1</PlatformID> <UserName>username</UserName> <ChannelCode>channelcode</ChannelCode> <PassWord>password</PassWord> </MainReportRoot>

12 Çıktısı aşağıdaki gibi olacaktır : 5123 ORIGINATOR1 ORIGINATOR2 Hata Kodları : 01 : Username/Password yanlış girilmiş. 9. Cancel Job ( İleri Tarihli bir gönderimin iptal edilmesi ) İleri tarihli bir gönderimi iptal etmek için aşağıdaki XML kullanılır. <CancelJob> <Command>4</Command> <PlatformID>1</PlatformID> <UserName>test</UserName> <ChannelCode> channelcode</channelcode> <PassWord>pwd</PassWord> <MsgID>123456</MsgID> </CancelJob> Başarılı Durum : OK : İşlem iptal edildi Hata Kodları : 01 : Username/PassWord yanlış girilmiş ya da ID girilmemiş. 02 : İşlem iptal edilemedi ( işlem tamamlanmış ya da şu anda yapılıyor )

13 10. Check Date ( Güncel Sistem Saatinin öğrenilmesi ) Güncel Sistem Saati için XML aşağıdaki gibidir. <CheckDate> <Command>5</Command> <PlatformID>1</PlatformID> <UserName>username</UserName> <ChannelCode> channelcode</channelcode> <PassWord>password</PassWord> </CheckDate> Başarılı Durum : : Güncel sistem saati ddmmyyyyhhmm formatında döner. Hata Kodları : 01 : Username/PassWord yanlış girilmiş ya da ID girilmemiş. 07 : Genel hata.