LINK Mobility Uygulama Kılavuzu REST API SMS
LINK Mobility, mesaj teslimi, mikro ödemeler ve konum tabanlı hizmetler için bir hizmet sağlar. Platform, Servis Sağlayıcılar ve Operatörler arasında şeffaf, beyaz etiketli bir içerik alıcısı ve işlem yönlendiricisi olarak işlev görür.
LINK Mobility, SMS gönderme gibi LINK Mobility hizmetlerine erişmek için kullanılabilen bir RESTful API sağlar. Bu API, kullanımı kolay ve tüm modern diller ve çerçevelerle uyumlu olacak şekilde tasarlanmıştır. Tercih ettiğiniz dili kullanarak uygulamanız, güçlü mesajlaşma ve ödeme yeteneklerini uygulamak için Link Mobility REST API'sini kullanabilir
© LINK Mobility, 10 Mart 2021
Yasal Bilgiler
Bu belgede sağlanan bilgiler Netsize'ın tek mülkiyeti ve telif hakkıdır. Gizlidir ve kesinlikle bilgilendirme amaçlıdır. Bağlayıcı değildir ve bildirimde bulunulmaksızın değişikliğe tabi olabilir. Yetkisiz herhangi bir açıklama veya kullanım hukuka aykırı olarak kabul edilecektir.
Netsize™ ve linkmobility™ Fransa, AET ve uluslararası fikri mülkiyet yasaları tarafından korunmaktadır.
Alıntı yapılan diğer tüm ticari markalar yalnızca ilgili sahiplerinin mülkiyetindedir.
Burada yer alan hiçbir şey Netsize patenti, telif hakkı veya ticari markası kapsamında herhangi bir lisans veya hak verildiği şeklinde yorumlanmayacaktır.
NET BOYUTU
5 478 070 Euro sermayeli anonim şirket
Siege sosyal :62, cadde Emile Zola92100 Boulogne – Fransa
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Belgenin Kapsamı
Bu belge, Servis Sağlayıcının SMS için LINK Mobility REST API'sini nasıl kullandığını açıklar. Servis Sağlayıcının hizmetlerini uygulayan teknik mimarlar ve tasarımcılar için tasarlanmıştır.
1. Temel Kullanım
SMS göndermek çok kolaydır. LINK Mobility'ye sadece bir HTTP isteği göndererek bunu gerçekleştirebilirsiniz. web tarayıcı.
2. İşlevsellik Bittiview
LINK Mobility sistemi, SMS mesajları için aşağıdaki temel işlevleri sağlar:
Metin veya ikili (örneğin WAP Push) premium ve standart ücretli mesajlar gibi Mobil Sonlandırılmış (MT) SMS mesajları gönderme.
Gönderilen MT mesajları için teslimat raporlarının alınması.
Mobil Kaynaklı (MO) SMS mesajlarını premium ve standart tarifelerle alma.
SMS REST API, standart oranlı MT SMS mesajları göndermek için tasarlanmıştır.
API, tüm SMS mesajlarını asenkron olarak göndererek şu gibi özelliklerin kullanılmasını sağlar:
“Çalıştır ve unut” – Servis Sağlayıcı daha öngörülebilir yanıt sürelerine sahip olmak ister ve Operatörden sonuç beklemek istemez.
Yeniden deneme işlevi – Operatörde geçici sorunlar varsa LINK Mobility mesajı yeniden gönderecektir.
2.1 SMS mesajı gönderme
Servis Sağlayıcı Netsize Tüketici
- MT mesajını gönder
- Mesaj kimliğini döndür
- SMS mesajı gönder
- Teslimat raporunu teslim et
- Teslimat raporu gönder
SMS mesajı göndermenin temel akışı aşağıdaki şekilde açıklanmaktadır:
Servis Sağlayıcı, LINK Mobility sistemi üzerinden bir alıcıya SMS mesajı gönderilmesi talebinde bulunur.
Servis Sağlayıcıya bir mesaj kimliği döndürülür. Bu kimlik örneğin mesajı doğru teslimat raporuyla ilişkilendirmek için kullanılabilir.
LINK Mobility yönlendirmeyi gerçekleştirir ve SMS mesajını hedef Tüketiciye iletir.
Örneğin, SMS mesajı Tüketicinin cihazına iletildiğinde bir teslimat raporu tetiklenir.
Teslimat raporu Servis Sağlayıcıya gönderilir. Rapor, 2. adımda döndürülenle aynı ileti kimliğini içerir.
Alternatif akış: Geçersiz istek
İstekte sağlanan parametreler veya kullanıcı kimlik bilgileri geçersizse, Servis Sağlayıcıya bir hata döndürülür. Hata, reddetme nedenini belirtir ve akış sona erer. Hiçbir ileti kimliği döndürülmez.
3. Son Nokta
SMS kaynağına şu yol kullanılarak erişilir:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Bağlantı güvenliği için LINK Mobility REST API'ye yalnızca HTTPS üzerinden erişilebilir.
Link Mobility sunucu sertifikası Thawte Server CA tarafından imzalanmıştır.
4. Operasyonlar
SMS hizmeti aşağıdaki işlemleri sağlar:
| İsim | Yol |
| Göndermek | /restapi/v1/sms/gönder |
4.1 Gönder
Gönderme işlemi, tek bir alıcıya SMS göndermek için kullanılır.
Bu işlem hem temel hem de ileri düzey kullanıcılar için tasarlanmıştır. En basit durumda, bir SMS göndermek için yalnızca hedef adres ve mesaj metni gerekir. LINK Mobility, Veri Kodlama Şemasını algılayacak ve gerekirse bir mesajın birden fazla mesaj parçasına otomatik olarak birleştirilmesini gerçekleştirecektir.
Gelişmiş kullanım için Servis Sağlayıcı, kullanıcı verisi başlığı da dahil olmak üzere mesaj biçimlendirmesinin tam kontrolü için isteğe bağlı parametreler kullanabilir.
Servis Sağlayıcı, zincirleme mesajlar gönderebilir ancak kullanıcı verisi ve kullanıcı verisi başlığının hazırlanması Servis Sağlayıcı tarafından yapılmalı ve mesaj, LINK Mobility'ye doğru çoklu gönderme istekleri yoluyla gönderilmelidir.
5. Kimlik doğrulama
Her istekte HTTP Temel Kimlik Doğrulama Şeması kullanılarak kullanıcı adı ve şifre gönderilir.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Kimlik bilgileri HTTP isteğinde bir Yetkilendirme başlığında gönderilir. İstemci başlık alanını burada açıklandığı gibi oluşturur:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
ÖrneğinampÖrneğin, kullanıcı adı john ve şifre changeme ise ortaya çıkan Yetkilendirme başlığı şu şekilde olur:
Yetkilendirme: Temel am9objpjaGFuZ2VtZSA=
Bir geri dönüş olarak kullanıcı adı ve parola istek parametreleri olarak gönderilebilir. Bu yalnızca Basic Auth'u desteklemeyen istemciler için önerilir.
6. Bir talep gönderme
6.1 Sorgu dizesi
İstek parametreleri ad/değer çiftleri içeren bir sorgu dizesi olarak gönderilir. Sorgu dizesi Yüzde Kodlaması kullanılarak kodlanır (URL (kodlama).
http://www.w3schools.com/tags/ref_urlencode.asp
ÖrneğinampMerhaba Dünya! ifadesi Merhaba+Dünya%21 şeklinde kodlanır.
6.2 Zorunlu istek parametreleri
| İsim | Maksimum uzunluk | Tanım |
| hedefAdres | 40 | SMS mesajının gönderileceği MSISDN, ülke koduyla başlayarak. Örn.ampdosya: 46123456789. Bazı pazarlar için (Tüketici MSISDN'sinin gizlenmesi gereken yerlerde) bu değer, "#" ile öneklenen alfanümerik bir takma ad da olabilir. |
| mesajMetin | 1600 | SMS mesajının içeriği. |
6.3 İsteğe bağlı istek parametreleri (gelişmiş kullanım için)
| İsim | Maksimum uzunluk | Tanım |
| kaynakAdresi | 16 | Giden SMS mesajının kaynak adresi. Kaynak adresin türü originatorTON parametresi tarafından tanımlanır. Kısa numaranın maksimum uzunluğu 16'dır. Alfanümerik gönderici GSM varsayılan Alfabesi ile sınırlıdır ve maksimum uzunluğu 11 karakterdir. MSISDN göndericisinin maksimum uzunluğu 15'tir (destinationAddress öğesiyle aynı formatı kullanır). originatingAddress ve originatingTON sistem tarafından seçildiğinde atlanabilir. Bu fonksiyon pazar ve yapılandırmaya bağlıdır. Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| orijinatörTON | 1 | Kaynak adresin numara türü (TON): 0 – Kısa sayı 1 – Alfanümerik (maksimum uzunluk 11) 2 – MSISDN originatingAddress ve originatingTON sistem tarafından seçilecekse atlanabilir. Bu fonksiyon pazar ve yapılandırmaya bağlıdır. Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| kullanıcıVeriBaşlığı | 280 | Kullanıcı Verisi Başlığı, Kullanıcı Verileriyle birlikte 140'a kadar, yani hex kodlandığında 280 oktet içerebilir. Bu parametre her zaman hex kodlanmıştır. |
| DÇS | 3 | Veri kodlama şeması. Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| PID | 3 | Protokol Kimliği. Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| göreliGeçerlilikZamanı | 6 | Göreceli geçerlilik süresi saniye cinsinden (LINK Mobility'ye gönderim süresine göre). Maksimum değer 604800'dür (7 gün) ve varsayılan değer 48 saattir. Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| teslimat süresi | 20 | zamanamp SMS mesajının ne zaman teslim edilmesi gerektiği (gecikmeli teslim süresi). Tarih saat biçimi bölümüne bakın. |
| durumRaporBayrakları | 1 | Rapor isteğini ilet: 0 – Teslimat raporu yok (varsayılan) 1 – Teslimat raporu talep edildi 9 – Sunucu teslimat raporu talep edildi (LINK Mobility raporu Servis Sağlayıcıya iletmiyor ancak raporlarda vb. mevcut kılıyor) |
| campaignAdı | 50 | LINK Mobility işlemleri tagBu adla ged. Bağlantı Hareketliliği raporlarında işlemleri gruplamak için kullanılır. |
| maxBirleştirilmişİletiler | 1 | İzin verilen birleştirilmiş mesaj sayısını tanımlayan 1 ile 10 arasında bir değer. Varsayılan 3'tür. |
| korelasyonId | 100 | Teslimat Raporunda yansıtılacak olan Servis Sağlayıcısı tarafından sağlanan ID. |
| kullanıcı adı | 100 | HTTP Temel Kimlik Doğrulamasına alternatif olarak sağlanır. |
| şifre | 100 | HTTP Temel Kimlik Doğrulamasına alternatif olarak sağlanır. |
6.4 HTTP İstek Yöntemleri
Maksimum birlikte çalışabilirlik için API, hem HTTP GET hem de POST istek yöntemlerini destekler. Başka hiçbir HTTP yöntemine izin verilmez.
6.4.1 AL
Kodlanmış sorgu dizesi şuraya eklenir: URL.
ELDE ETMEK
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Merhaba+Dünya%21
Yetkilendirme: Temel am9objpjaGFuZ2VtZSA=
6.4.2 GÖNDER
Kodlanmış sorgu dizesi HTTP istek mesajı gövdesine gönderilir. İçerik Türü application/x-www-form-urlkodlanmış.
POSTALAMAK https://europe.ipx.com/restapi/v1/sms/send
Sunucu: europe.ipx.com
İçerik Türü: application/x-www-form-urlkodlanmış
Yetkilendirme: Temel am9objpjaGFuZ2VtZSA=
İçerik Uzunluğu: 57
destinationAddress=46123456789&messageText=Merhaba+Dünya%21
6.5 Tarih ve saat
REST API'deki tarih ve saati temsil eden parametreler her zaman UTC zaman dilimindedir (Eşgüdümlü Evrensel Zaman).amps'ler tam olarak şu formatta bir dize olarak temsil edilir:
2017-04-25T23:20:50Z
Bu, 20 Nisan 50'nin UTC saatinden 23'üncü saatten 25 dakika 2017 saniye sonrasını temsil ediyor.
7. Yanıt mesajı
API, bir istek mesajını alıp yorumladıktan sonra bir HTTP yanıt mesajıyla yanıt verir.
7.1 HTTP durum kodu
REST API, işlenen istekler için her zaman HTTP durum kodu 200 OK döndürür. İleti gövdesi, kesin sonucu belirlemek için kullanılan bir responseCode parametresi içerir.
7.2 Mesaj gövdesi
Mesaj gövdesi, isteğin sonucunu açıklayan JSON'dan oluşur.
http://json.org/
Link Mobility JSON, Google JSON Stil Kılavuzu'na uygundur.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Yanıt parametreleri
| İsim | Maksimum uzunluk | Tanım |
| yanıtKodu | 3 | 0 başarılı işlemi ifade eder. |
| cevapMesajı | 255 | Cevap metinsel açıklaması, örneğin hata metni. |
| zamanamp | 20 | LINK Mobility'nin isteği işlediği tarih ve saat. (Tarih/saat biçimi bölümüne bakın). |
| izleme kimliği | 36 | Bağlantı Mobilitesi dahili tanımlayıcısı. Destek ve sorun giderme için kullanılır. |
| mesajKimlikleri | 10x36 | Her başarılı mesaj için LINK Mobility benzersiz mesaj kimlikleri dizisi (mesaj birleştirilirse birden fazla mesaj kimliği döndürülür). Başarısızlık durumunda atlanır. |
7.4 Örn.ampyanıtlar
Başarı
HTTP/1.1 200 TAMAM
İçerik Türü: application/json
İçerik Uzunluğu: 144
Tarih: Per, 15 Eyl 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Başarılı”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
İşte okunabilirlik açısından biçimlendirilmiş aynı JSON:
{
"yanıtKodu“:0,
"cevapMesajı":"Başarı",
"zamanamp“:”2016-0915T13:20:31Z”,
"izleme kimliği“:”f678d30879fd4adc25f2”,
"mesajKimlikleri“:[“1-4850879008”] }
Arıza
HTTP/1.1 200 TAMAM
İçerik Türü: application/json
İçerik Uzunluğu: 148
Tarih: Per, 15 Eyl 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:”Geçersiz oturum açma veya yetkisiz API kullanımı”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Başarı
HTTP/1.1 200 TAMAM
İçerik Türü: application/json
İçerik Uzunluğu: 144
Tarih: Per, 15 Eyl 2016 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Başarılı”,”timestamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
İşte okunabilirlik açısından biçimlendirilmiş aynı JSON:
{
"yanıtKodu“:0,
"cevapMesajı":"Başarı",
"zamanamp“:”2016-0915T13:20:31Z”,
"izleme kimliği“:”f678d30879fd4adc25f2”,
"mesajKimlikleri“:[“1-4850879008”] }
Arıza
HTTP/1.1 200 TAMAM
İçerik Türü: application/json
İçerik Uzunluğu: 148
Tarih: Per, 15 Eyl 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:”Geçersiz oturum açma veya yetkisiz API kullanımı”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Yanıt kodları
Gönderme yanıtında aşağıdaki yanıt kodları döndürülebilir:
| Kod | Metin | Tanım |
| 0 | Başarı | Başarıyla gerçekleştirildi. |
| 1 | Geçersiz oturum açma veya yetkisiz API kullanımı | Hatalı kullanıcı adı veya şifre veya Servis Sağlayıcısı LINK Mobility tarafından engellenir. |
| 2 | Tüketici Link Mobility tarafından engellendi | Tüketici LINK Mobility tarafından engellendi. |
| 3 | İşlem LINK Mobility tarafından sağlanmıyor | İşlem Servis Sağlayıcı için engellendi. |
| 4 | Tüketici LINK Mobility tarafından bilinmiyor | Tüketici LINK Mobility tarafından bilinmemektedir. Veya istekte takma ad kullanılmışsa; takma ad bulunamadı. |
| 5 | Tüketici bu hizmeti LINK Mobility'de engelledi | Tüketici bu hizmeti LINK Mobility'de engelledi. |
| 6 | Kaynak adresi desteklenmiyor | Kaynak adresi desteklenmiyor. |
| 7 | Hesap, alfa kökenli adresi desteklemiyor | Alfa kaynak adresi hesap tarafından desteklenmiyor. |
| 8 | MSISDN kaynak adresi desteklenmiyor | MSISDN kaynak adresi desteklenmiyor. |
| 9 | GSM genişletilmiş desteklenmiyor | GSM genişletilmiş desteklenmiyor. |
| 10 | Unicode desteklenmiyor | Unicode desteklenmiyor. |
| 11 | Durum raporu desteklenmiyor | Durum raporu desteklenmiyor. |
| 12 | Gerekli yetenek desteklenmiyor | Mesajın gönderilmesi için gereken yetenek (yukarıdakilerin dışında) desteklenmiyor. |
| 13 | İçerik sağlayıcının maksimum kısıtlama oranı aşıldı | Servis Sağlayıcı, SMS mesajlarını LINK Mobility'ye çok hızlı gönderiyor. |
| 14 | Protokol kimliği hesap tarafından desteklenmiyor | Protokol kimliği desteklenmiyor. |
| 15 | Mesaj birleştirme sınırı aşıldı | Birleştirilmiş mesaj sayısı istenen maksimum sayıyı aşıyor. |
| 16 | Mesaj yönlendirilemiyor. | LINK Mobility mesajı yönlendiremedi. |
| 17 | Yasaklanmış zaman dilimi | Zaman aralığında mesaj gönderilmesine izin verilmiyor |
| 18 | Hizmet sağlayıcı hesabındaki bakiye çok düşük | Hizmet sağlayıcısı Çok düşük bakiye nedeniyle engellendi |
| 50 | Kısmi başarı | Birden fazla alıcıya SMS gönderildiğinde kısmi başarı. |
| 99 | İç Sunucu Hatası | Diğer Link Mobility hatası, daha fazla bilgi için LINK Mobility desteğiyle iletişime geçin. |
| 100 | Geçersiz hedef adresi | Hedef adres (MSISDN veya takma ad) geçersiz. |
| 102 | Geçersiz referanslı (bağlantılı) kimlik | Referans ID geçersiz, belki referans ID daha önce kullanılmış, çok eski veya bilinmiyor. |
| 103 | Geçersiz hesap adı | Hesap adı geçersiz. |
| 105 | Geçersiz hizmet meta verileri | Hizmet meta verisi geçersiz. |
| 106 | Geçersiz kaynak adresi | Kaynak adresi geçersiz. |
| 107 | Geçersiz alfanümerik kaynak adresi | Alfanümerik kaynak adresi geçersiz. |
| 108 | Geçersiz geçerlilik süresi | Geçerlilik süresi geçersizdir. |
| 109 | Geçersiz teslimat süresi | Teslimat süresi geçersiz. |
| 110 | Geçersiz mesaj içeriği/kullanıcı verisi | Kullanıcı verileri yani SMS mesajı geçersiz. |
| 111 | Geçersiz mesaj uzunluğu | SMS mesajı uzunluğu geçersiz. |
| 112 | Geçersiz kullanıcı veri başlığı | Kullanıcı verisi başlığı geçersiz. |
| 113 | Geçersiz veri kodlama şeması | DCS geçersiz. |
| 114 | Geçersiz protokol kimliği | PID geçersiz. |
| 115 | Geçersiz durum raporu işaretleri | Durum raporu işaretleri geçersiz. |
| 116 | Geçersiz TON | Oluşturan TON geçersizdir. |
| 117 | Geçersiz campadı | campAign adı geçersiz. |
| 120 | Birleştirilmiş iletilerin maksimum sayısı için geçersiz sınır | Birleştirilmiş mesajların maksimum sayısı geçersiz. |
| 121 | Geçersiz msisdn kaynak adresi | MSISDN kaynak adresi geçersiz. |
| 122 | Geçersiz korelasyon kimliği | Korelasyon kimliği geçersiz. |
8. İsteğe bağlı özellikler
8.1 MSISDN Düzeltmesi
MSISDN düzeltmesi, talep edilmesi halinde LINK Mobility desteği tarafından etkinleştirilebilen isteğe bağlı bir özelliktir.
Bu özellik hedef adresleri düzeltecek ve bunları gerekli E.164 biçimine hizalayacaktır. Biçim düzeltmesine ek olarak sistem, geçerli olduğunda uluslararası Fransız numaralarını doğru DOM-TOM (départements et territoires d'outre-mer) numaralarına çevirmek gibi pazara özgü işlevleri de gerçekleştirebilir.
Aşağıda birkaç örnek bulunmaktadırampDüzeltmeler:
| Gönderilen Hedef Adres | Düzeltilmiş Hedef Adresi |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445aaa | 46702233445 |
| 336005199999 | 2626005199999 (Fransızca sayı DOM-TOM sayısına çevrilmiştir) |
Ek olarak, seçili bir pazar için ulusal telefon numaralarına izin vermek mümkündür. Bu özellik etkinleştirildiğinde, diğer pazarlar için herhangi bir uluslararası numara, seçili pazardan ayırt edilmeleri için başlangıçta `+' işaretiyle gönderilmelidir.
Aşağıda birkaç örnek bulunmaktadırampUlusal numaralar için varsayılan pazar olarak İsveç (ülke kodu 46) kullanıldığında yapılan düzeltmelerin kayıtları.
| Gönderilen Hedef Adres | Düzeltilmiş Hedef Adresi |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | '+' işareti eksik olduğundan geçersiz |
Düzeltilen MSISDN’nin LINK Mobility tarafından kullanılacağını ve teslimat raporlarında geri döndürüleceğini unutmayın.
Daha fazla bilgi için lütfen LINK Mobility desteğiyle iletişime geçin.
8.2 Karakter Değiştirme
Karakter değiştirme, talep edilmesi halinde LINK Mobility desteği tarafından etkinleştirilebilen isteğe bağlı bir özelliktir.
Bu özellik, DCS “GSM” (17) olarak ayarlandığında kullanıcı verilerindeki (SMS metni) GSM olmayan alfabe karakterlerini eşdeğer GSM alfabe karakterlerine çevirecektir. Örneğinample “Seqüência de teste em Português”, “Seqüencia de teste em Portugues” olarak tercüme edilecektir.
9. Teslimat raporları
Hizmet Sağlayıcı, sağlanmışsa, gönderilen MT mesajları için SMS mesajı teslim raporları veya teslim bildirimleri talep edebilir. Bu raporlar, MT mesajı hedeflenen Tüketiciye iletildiğinde veya silindiğinde, örneğin süresi dolduğunda veya herhangi bir nedenle yönlendirilemediğinde Operatör SMSC'sinde tetiklenir.
SMS mesajının yalnızca son durumu, yani teslim edildi veya silindi, Servis Sağlayıcısına bildirilir. MT mesajı başına yalnızca bir rapor oluşturulur. Silinmiş durumla birlikte bir neden kodu uygulanabilir. Bu neden kodu, SMS mesajının teslim edilmemesinin nedenini belirtir.
Raporlar LINK Mobility üzerinden yönlendirilir ve HTTP protokolü kullanılarak Servis Sağlayıcıya gönderilir.
Raporları almak için, Servis Sağlayıcının örneğin aşağıdakileri uygulaması gerekir:ampJava Servlet veya ASP.NET sayfası. Her ikisi de HTTP GET veya POST istekleri alır.
Parametreler
İstek aşağıdaki parametreleri içerir:
| Parametre | Tip | E/B/B* | Varsayılan Değer | Maksimum uzunluk | Tanım |
| MesajKimliği | sicim | M | – | 22 | Bu raporun karşılık geldiği MT mesajının mesaj kimliği. |
| HedefAdres | sicim | M | – | 40 | Tüketicinin MSISDN'si, yani orijinal MT mesajının hedef adresi. |
| DurumKodu | tam sayı | M | 1 | Durum kodu MT mesajının durumunu belirtir. Uygulanabilir durum kodları şunlardır: 0 – Teslim edildi 2 – Silindi (sebep kodu geçerlidir) |
|
| TimeStamp | sicim | M | – | 20 | Teslimat raporunun LINK Mobility tarafından alındığı zamanı gösteren saat. Zamanın en son zaman dilimiamp CET veya CEST'dir (AB için tanımlanan yaz saati uygulamasıyla). Biçim: yyyyAAgg SS:dd:ss. |
| Operatör | sicim | M | – | 100 | SMS gönderilirken kullanılan Operatör adı veya SMS gönderilirken kullanılan hesap adı. Mevcut Operatörlerin listesi LINK Mobility desteği tarafından sağlanmaktadır. |
| NedenKodu | tam sayı | O | – | 3 | Neden kodu, mesajın neden silindi durumunda olduğunu belirtir. Uygulanabilir neden kodları şunlardır: 100 – Süresi doldu 101 – Reddedildi 102 – Biçim hatası 103 – Diğer hata 110 – Abone bilinmiyor 111 – Abone engellendi 112 – Aboneye provizyon sağlanamadı 113 – Abone mevcut değil 120 – SMSC arızası 121 – SMSC tıkanıklığı 122 – SMSC dolaşımı 130 – El cihazı hatası 131 – El cihazı belleği aşıldı Davranış Operatör entegrasyonlarına göre değişiklik gösterebilir. |
| OperatörTimeStamp | sicim | O | – | 20 | Operatörün SMSC'sinde (Operatör tarafından sağlanmışsa) raporun ne zaman tetiklendiğini gösteren zaman. Zamanın en son zaman dilimiamp CET veya CEST'dir (AB için tanımlanan yaz saati uygulamasıyla). Biçim: yyyyAAgg SS:dd:ss. |
| Durum Metni | sicim | O | – | 255 | Operatörden ek bilgiler için yer tutucu, örneğin durum/nedenin açık metin açıklaması. Davranış, Operatör entegrasyonlarına göre değişebilir. |
| Korelasyon Kimliği | sicim | O | – | 100 | SendRequest veya SendTextRequest'te sağlanan korelasyon kimliği. |
| OperatörAğKodu | tam sayı | O | – | 6 | Operatörün Mobil Şebeke Kodu (MCC + MNC). |
* M = Zorunlu, O = İsteğe bağlı, I = Göz ardı edildi.
Hizmet Sağlayıcısı, LINK Mobility'ye hedef URL teslimat raporları için (isteğe bağlı olarak HTTP temel kimlik doğrulaması için kimlik bilgileri dahil). Servis Sağlayıcı hangi tercih edilen HTTP yönteminin kullanılacağını seçebilir:
HTTP POST (önerilir)
HTTP GET.
ExampHTTP GET kullanılarak (başarıyla teslim edildi):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
ExampHTTP GET kullanarak (teslim edilmedi, Operatör zamanları sağladı)amp (etkinlik için):
Parametreler şunlardır: URL kodlandı.
Karakter kodlaması:
Servis Sağlayıcı hangi tercih edilen karakter kodlamasının kullanılacağını seçebilir:
UTF-8 (önerilir)
ISO-8859-1.
9.1 Hizmet Sağlayıcı onayı
Servis Sağlayıcı her teslimat raporunu onaylamalıdır. Onay olumlu olabilir, yani teslimat raporu başarıyla alındı veya olumsuz olabilir, yani başarısızlık.
Lütfen dikkat: LINK Mobility'nin teslimat raporları için 30 saniyelik bir onay okuma zaman aşımı vardır. Bir zaman aşımı, teslimatın tekrar denenmesini (tekrar deneme etkinleştirilmişse) veya teslimatın iptalini (tekrar deneme devre dışı bırakılmışsa) tetikler. Bu, Servis Sağlayıcı uygulamasının özellikle yoğun yük sırasında hızlı yanıt süreleri sağlaması gerektiği anlamına gelir.
Teslimat raporunun işleme alınmadan önce LINK Mobility'ye iletilmesi önemle tavsiye edilir.
Olumlu ve olumsuz teyidin kuralı şu şekilde açıklanmaktadır:
Olumlu onay, ACK, teslimat raporu iletildi:
Aşağıdaki XML biçimli içerikle birlikte HTTP 200 aralığı yanıt kodu:
Olumsuz teyid, NAK, teslimat raporu teslim edilmedi:
Örneğin olumlu bir onaydan başka herhangi bir cevapampÖrneğin, herhangi bir HTTP hata kodu veya aşağıdaki XML içeriği olumsuz bir onay tetikler:
XML içeriği, LINK Mobility yeniden deneme mekanizmasını kontrol etmek için kullanılabilir. Etkinleştirilirse bir NAK yeniden deneme girişimine neden olur. Yeniden deneme mekanizması için yapılandırılmamış Servis Sağlayıcıları için XML içeriği isteğe bağlıdır.
Aşağıda bir HTTP POST isteği ve yanıtı gösterilmektedirampBir Servis Sağlayıcıya teslim edilen teslimat raporunun örneği:
HTTP İsteği:
POST /bağlam/uygulama HTTP/1.1
İçerik Türü: application/x-www-form-urlkodlanmış;charset=utf-8
Ana bilgisayar: sunucu:port
İçerik Uzunluğu: xx
MesajKimliği=213123213&HedefAdresi=46762050312&Operatör=Telia& OperatörZamanAdıamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
HTTP Yanıtı:
HTTP/1.1 200 TAMAM
İçerik Türü: metin/düz
9.2 Tekrar dene
LINK Mobility sistemi başarısız, yani onaylanmamış teslimat raporu teslimatları için yeniden deneme girişimleri gerçekleştirebilir. Servis Sağlayıcı tercih edilen yeniden deneme davranışını seçebilir:
Tekrar deneme yok (varsayılan) – bağlantı girişimi başarısız olursa, okuma zaman aşımına uğrarsa veya herhangi bir HTTP hata kodu varsa mesaj atılır.
Tekrar dene – Her türlü bağlantı sorunu, okuma zaman aşımı veya olumsuz onay durumunda mesaj yeniden gönderilecektir.
NAK için yeniden deneme etkinleştirildiğinde, LINK Mobility'den hangi senaryoların yeniden deneme girişimi oluşturacağını ve yeniden denemenin nasıl çalıştığını anlamak önemlidir. Her Servis Sağlayıcısının, mesajların mesaj zamanına göre sıralandığı kendi yeniden deneme kuyruğu vardır.amp. Bağlantı Mobilitesi, Servis Sağlayıcısına iletilen mesajların bireysel sırası garanti edilmese bile, her zaman önce eski mesajları iletmeye çalışır. Mesajların yeniden deneme kuyruğundan atılmasının temel nedeni iki nedenden biridir: ya mesaj TTL'si sona erer ya da (teorik olarak) yeniden deneme kuyruğu dolar. TTL, Operatöre ve hesaba bağlıdır, yani Operatöre ve/veya mesaj türüne (örneğin, premium SMS veya standart oranlı SMS mesajı) bağlı olarak değişebilir.
Yeniden deneme özelliği etkinleştirilmiş bir Servis Sağlayıcısı, mesajın daha önce alınmadığından emin olmak için MT mesajının benzersiz kimliğini kontrol etmelidir.
Teslimat raporunun işlenmesi sırasında bir hata oluştuğunda Servis Sağlayıcının bu basit kurallara uyması önemlidir; hatanın nedeni şuysa: Geçici, örneğin veritabanı mevcut değil, bir NAK döndürülmelidir. LINK Mobility mesajı yeniden gönderecektir.
Kalıcı ve yeniden deneme girişimi aynı türde bir soruna neden olma olasılığı yüksektir, bir ACK döndürülmelidir. Örneğinample, ileti doğru şekilde ayrıştırılamadığında veya beklenmeyen bir çalışma zamanı hatasına neden olduğunda.
Buna göre hareket edilmesi, teslimat raporunun tekrar tekrar gönderilmesi nedeniyle herhangi bir engelleme veya verim düşüklüğü yaşanmamasını sağlayacaktır.
10. Uygulama ipuçları
1. Sizin kullanmanız mümkün web API'ye istek göndermek için tarayıcı. Bu, herhangi bir geliştirme aracı olmadan hizmetleri keşfetmeyi ve değerlendirmeyi çok kolaylaştırır.
2. JSON gibi bir uzantıyla birlikte Chrome veya Firefox önerilirView güzel biçimlendirilmiş JSON'u görüntülemek için.
3. POST, Temel Kimlik Doğrulama'yı test etmek ve ham HTTP istek ve yanıt mesajlarını incelemek için SoapUI'yi kullandık.
4. cURL araç, Temel Kimlik Doğrulama ile POST istekleri göndermek için yararlıdır. Örnek olarak bkz.ampAşağıda.
curl POSTALAMAK \
-H “İçerik Türü: uygulama/x-www-form-urlkodlanmış” \
-H “Yetkilendirme: Temel am9objpjaGFuZ2VtZSA=” \
https://europe.ipx.com/restapi/v1/sms/send \
–data “destinationAddress=46123456789&messageText=Merhaba+Dünya%21”
_______________
Kişiselleştirilmiş İletişimleri Dönüştürmek
Belgeler / Kaynaklar
 |
LINK Mobility Uygulama Kılavuzu REST API SMS [pdf] Kullanıcı Kılavuzu Mobilite Uygulama Kılavuzu REST API SMS, Mobilite, Uygulama Kılavuzu REST API SMS, REST API SMS, API SMS, SMS |
