Tel : 0(532) Web : E-Posta : info@kayikcioglugrup.com. İLETİ PAKETİ API (Entegrason) Dökümanı

Transkript

1 İLETİ PAKETİ API (Entegrason) Dökümanı

2 HTTP GET API SMS Gönderimi İstek yapılacak adres: Yapılacak olan istek örneği: or%20sit%20amet&receipents= , &sender=iletipaketi İstekte gönderilen parametrelerin açıklamaları aşağıdaki gibidir: username: iletipaketi.com a giriş yaparken kullanılan kullanıcı adıdır. Genellikle kayıt aşamasında verilen cep telefonu numarasıdır. İstek yapılırken gönderilmesi password: iletipaketi.com a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi text: Gönderilecek olan SMS metnini içerir. İstek yapılırken gönderilmesi URL encode işleminden geçirilmelidir. receipents: Alıcının cep telefonu numarasını içerir. Numara formatı 5xxxxxxxxx şeklinde olmalıdır. İstek yapılırken gönderilmesi Belirtilen mesaj metni için birden fazla alıcı tanımlanacaksa numaralar virgül ile ayrılmalıdır. sender: iletipaketi.com yönetim panelinden tanımlamış ve iletipaketi.com tarafından onaylanmış, maksimum 11 karakterden oluşan başlık bilgisidir. Gönderilen mesaj, alıcıya bu parametre ile belirtilen başlık ile yollanır. İstek yapılırken gönderilmesi URL encode işleminden geçirilmelidir.

3 HTTP XML POST API SMS Gönderimi İstek yapılacak adres: Yapılacak olan isteğin genel XML yapısı: <request> <authentication> <username></username> <password></password> </authentication> <sender></sender> <senddatetime></senddatetime> <text><![cdata[...]]></text> <receipents> <number></number> <number></number>... </receipents> </request> Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir: authentication: İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir:

4 username: iletipaketi.com a giriş yaparken kullanılan kullanıcı adıdır. Genellikle kayıt aşamasında verilen cep telefonu numarasıdır. İstek yapılırken gönderilmesi password: iletipaketi.com a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi order: Gönderilecek olan SMSler bir sipariş olarak kabul edilir ve istek yapıldıktan sonra bu şekilde raporlanmaya başlanır. Bu sipariş bazı zamanlar tek alıcıya tek mesaj içerebileceği gibi birden fazla alıcıya birden fazlı mesaj da içerebilir. Alt etiketleri aşağıdaki gibidir: sender: iletipaketi.com yönetim panelinden tanımlamış ve iletipaketi.com tarafından onaylanmış, maksimum 11 karakterden oluşan başlık bilgisidir. Gönderilen mesaj, alıcıya bu parametre ile belirtilen başlık ile yollanır. İstek yapılırken gönderilmesi senddatetime: Mesajın gönderim tarihini ifade eder. İleri tarihli mesaj gönderimleri için kullanılır. Formatı GG/AA/YYYY SS:DD şeklindedir. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri, istek yapılan zamandır. message: Gönderilecek olan mesaj bilgisini içerir. Alt etiketleri aşağıdaki gibidir: text: Gönderilecek olan SMS metnini içerir. İstek yapılırken gönderilmesi receipents: Gönderilecek olan SMSlerin alıcılarını içerir. Alıcılar aşağıdaki etiket ile belirtilir: number: Alıcının cep telefonu numarasını içerir. 905xxxxxxxxx, +90 5xx xxx xx xx, 5xxxxxxxxx gibi formatlar kullanılabilir. İstek yapılırken gönderilmesi Belirtilen mesaj metni için birden fazla alıcı tanımlanacaksa bu etiket alıcı sayısı kadar tekrarlanmalıdır.

5 Tek sipariş içinde farklı mesaj gönderilmek isteniyorsa message etiketi gönderilmek istenen farklı mesaj sayısı kadar tekrarlanmalıdır. order etiketi tekrarlanabilir bir etiket değildir. İstek başına yalnızca bir sipariş gönderilebilir. Sunucu yanıtının XML yapısı: <response> <status> <code></code> </status> <id></id> </response> Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketi alt etiketlerinin tanımı aşağıdaki gibidir: status: İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir: code: İşlem durumunu belirten numerik değerdir. message: İşlem durumu hakkında bilgi mesajı içerir. order: İşlem başarılı olarak tamamlandıysa oluşturulan sipariş bilgisini içerir. İşlem başarısızsa bu etiket döndürülmez. Alt etiketi aşağıdaki gibidir: id: Siparişi ifade eden eşsiz numerik değerdir. order etiketi tekrarlanabilir bir etiket değildir. İstek başına yalnızca bir sipariş gönderilebilir.

6 Örnek İstek <?xml version="1.0" encoding="utf-8"?> <request> <authentication> <username>kullanici_adi</username> <password>kullanici_sifresi</password> </authentication> <sender>iletipaketi</sender> <senddatetime>01/01/ :00</sendDateTime> <text><![cdata[lorem ipsum dolor sit amet, consectetur adipiscing elit.]]></text> <receipents> <number> </number> <number> </number> </receipents> <text><![cdata[nunc non mauris lectus. Vivamus non est enim.]]></text> <receipents> <number> </number> <number> </number> </receipents> </request> Örnek Yanıt <?xml version="1.0" encoding="utf-8"?> <response> <status> <code>200</code> İşlem başarılı </status> <id>428</id>

7 </response> Sipariş İptali İstek yapılacak adres: Yapılacak olan isteğin genel XML yapısı: <request> <authentication> <username></username> <password></password> </authentication> <id></id> </request> Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir: authentication: İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir: username: iletipaketi.com a giriş yaparken kullanılan kullanıcı adıdır. Genellikle kayıt aşamasında verilen cep telefonu numarasıdır. İstek yapılırken gönderilmesi password: iletipaketi.com a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi

8 order: İptal edilecek sipariş bilgisini içerir. Alt etiketi aşağıdaki gibidir: id: Siparişi ifade eden eşsiz numerik değerdir. order etiketi tekrarlanabilir bir etiket değildir. İstek başına yalnızca bir sipariş gönderilebilir. Sunucu yanıtının XML yapısı: <response> <status> <code></code> </status> </response> Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketi alt etiketlerinin tanımı aşağıdaki gibidir: status: İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir: code: İşlem durumunu belirten numerik değerdir. message: İşlem durumu hakkında bilgi mesajı içerir. Örnek İstek

9 <?xml version="1.0" encoding="utf-8"?> <request> <authentication> <username>kullanici_adi</username> <password>kullanici_sifresi</password> </authentication> <id>428</id> </request> Örnek Yanıt <?xml version="1.0" encoding="utf-8"?> <response> <status> <code>200</code> İşlem başarılı </status> </response> Bakiye Sorgulama İstek yapılacak adres: Yapılacak olan isteğin genel XML yapısı: <request>

10 <authentication> <username></username> <password></password> </authentication> </request> Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir: authentication: İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir: username: iletipaketi.com a giriş yaparken kullanılan kullanıcı adıdır. Genellikle kayıt aşamasında verilen cep telefonu numarasıdır. İstek yapılırken gönderilmesi password: iletipaketi.com a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi Sunucu yanıtının XML yapısı: <response> <status> <code></code> </status> <balance> <amount></amount> <sms></sms> </balance>

11 </response> Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketi alt etiketlerinin tanımı aşağıdaki gibidir: status: İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir: code: İşlem durumunu belirten numerik değerdir. message: İşlem durumu hakkında bilgi mesajı içerir. balance: Bakiye bilgilerini içerir. Alt etiketleri aşağıdaki gibidir: amount: Kullanıcı hesabında bulunan bakiye miktarını TL cinsinden içerir. sms: Kullanıcı hesabında bulunan SMS miktarını içerir. Örnek İstek <?xml version="1.0" encoding="utf-8"?> <request> <authentication> <username>kullanici_adi</username> <password>kullanici_sifresi</password>

12 </request> </authentication> Örnek Yanıt <?xml version="1.0" encoding="utf-8"?> <response> <status> <code>200</code> İşlem başarılı </status> <balance> <amount> </amount> <sms>7538</sms> </balance> </response> Sipariş Raporu Sorgulama İstek yapılacak adres: Yapılacak olan isteğin genel XML yapısı: <request> <authentication> <username></username> <password></password> </authentication>

13 <id></id> <page></page> <rowcount></rowcount> </request> Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir: authentication: order: İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir: username: iletipaketi.com a giriş yaparken kullanılan kullanıcı adıdır. Genellikle kayıt aşamasında verilen cep telefonu numarasıdır. İstek yapılırken gönderilmesi password: iletipaketi.com a giriş yaparken kullanılan şifredir. İstek yapılırken gönderilmesi Raporu sorgulanacak olan siparişin bilgisini içerir. Alt etiketleri aşağıdaki gibidir: id: Siparişi ifade eden eşsiz numerik değerdir. page: Rapor sayfasını ifade eder. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1 dir. rowcount: Bir rapor sayfasındaki mesaj adedini belirtir. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1000 dir. Maksimum değeri 1000 dir. Bir siparişte 1000 den fazla mesaj gönderilmişse ayrı bir istek ile diğer rapor sayfaları sorgulanmalıdır.

14 order etiketi tekrarlanabilir bir etiket değildir. İstek başına yalnızca bir sipariş gönderilebilir. Sunucu yanıtının XML yapısı: <response> <status> <code></code> </status> <number></number> <status></status> </response> Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketi alt etiketlerinin tanımı aşağıdaki gibidir: status: İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir: code: İşlem durumunu belirten numerik değerdir.

15 message: İşlem durumu hakkında bilgi mesajı içerir. order: İşlem başarılı olarak tamamlandıysa oluşturulan sipariş bilgisini içerir. İşlem başarısızsa bu etiket döndürülmez. Alt etiketleri aşağıdaki gibidir: id: Siparişi ifade eden eşsiz numerik değerdir. status: Siparişin genel gönderim durumunu belirten numerik değerdir. message: Örnek İstek Raporlanan mesaj bilgilerini içerir. Sorgulanan sayfadaki mesaj sayısı kadar tekrarlanır. Alt etiketleri aşağıdaki gibidir: number: Alıcının cep telefonu numarasını içerir. status: Mesajın gönderim durumunu belirten numerik değerdir. <?xml version="1.0" encoding="utf-8"?> <request> <authentication> <username>kullanici_adi</username> <password>kullanici_sifresi</password> </authentication> </request> <id>428</id> <page>1</page> <rowcount>5</rowcount> Örnek Yanıt <?xml version="1.0" encoding="utf-8"?>

16 <response> <status> <code>200</code> İşlem başarılı </status> <id>428</id> <status>113</status> <number> </number> <status>110</status> <number> </number> <status>111</status> <number> </number> <status>110</status> <number> </number> <status>111</status> <number> </number> <status>111</status> </response>

17 Durum Kodları ve Mesajları Durum Kodu Durum Mesajı 110 Mesaj Gönderiliyor 111 Mesaj Gönderildi 112 Mesaj Gönderilemedi 113 Siparişin Gönderimi Devam Ediyor 114 Siparişin Gönderimi Tamamlandı 115 Sipariş Gönderilemedi 200 İşlem Başarılı 400 İstek Çözümlenemedi 401 Üyelik Bilgileri Hatalı 402 Bakiye Yetersiz 404 API İstek Yapılan Yönteme Sahip Değil 450 Gönderilen Başlık Kullanıma Uygun Değil 451 Tekrar Eden Sipariş 452 Mesaj Alıcıları Hatalı 453 Sipariş Boyutu Aşıldı 454 Mesaj Metni Boş 455 Sipariş Bulunamadı 456 Sipariş Gönderim Tarihi Henüz Gelmedi 457 Mesaj Gönderim Tarihi Formatı Hatalı 503 Sunucu Geçici Olarak Servis Dışı Başlıklı Toplu SMS Gönderimi hakkında detaylı bilgi için;