Global Toplu SMS API

  • Published on
    29-Jul-2015

  • View
    65

  • Download
    6

Embed Size (px)

Transcript

1. Global Haberleme API Kullanc NotlarAuthor : Global HaberlemeVersion : 0.1SMS Gnderimi hakknda genel bilgilerSMS gndermek iin bilinmesi gereken genel konular banda sms uzunluklar vekullanlabilir karakterler gelmektedir. SMS gnderirken kullanabileceiniz karakterleraadaki gibidir.Standart SMS gnderimi iin izin verilen karakterler'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O','P', 'R', 'S', 'T', 'U', 'V', 'Y', 'Z', 'Q', 'W', 'X', 'a', 'b', 'c', 'd','e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'r', 's', 't','u', 'v', 'y', 'z', 'q', 'w', 'x', '0', '1', '2', '3', '4', '5', '6', '7','8', '9', '.', ',', '_', '', '?', '!', '(', ')', ';', ':', '@', ' ', '%','-', '+', '/', "n", '*', ''', '&', '='Trke SMS gnderimi iin izin verilen karakterler 2. 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O','P', 'R', 'S', 'T', 'U', 'V', 'Y', 'Z', 'Q', 'W', 'X', 'a', 'b', 'c', 'd','e', 'f', 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'r', 's', 't','u', 'v', 'y', 'z', 'q', 'w', 'x', '0', '1', '2', '3', '4', '5', '6', '7','8', '9', '.', ',', '_', '', '?', '!', '(', ')', ';', ':', '@', ' ', '%','-', '+', '/', "n", '*', ''', '&', '=', '', '', '', '', '', '', '','', '', '', '', ''Bu karakterler dndakiler metin ierisinden silinecektir. Mesaj uzunluklar ise u ekildedir.Standart ve Trke SMS'ler iin ksa mesaj iin karakter saylar aadaki gibidir.Standart SMS 160 KarakterTrke SMS 155 KarakterBu karater saylar zerindeki metinler iin uzun mesaj statsnde hesaplamalar yaplr vemesaj boyutuna gre kontr dlecektir.API Eriim BilgileriAPI'ye erimek iin key ve secret bilgilerinizi olmas gerekiyor. Bu bilgileriglobalhaberlesme.com adresinden ye olarak ya da giri yaparak renebilirsiniz. API key vesecret bilgisinin bir rneini aada bulabilirsiniz.key : 8eaa3ca9e32334fa4527e9843598abf9secret : a3uBxqMKlzSgrSrO3KB6YXWQ3lIwGBRmxbZE5rcHawSfFDsGZ2s1lyLQqJKv3MYvBu bilgiler ile API arayznden iletiim kurmak iin isteinize GET parametresi olarakeklemeniz yeterlidir. key ve secret bilgilerimizin doruluunu kontrol etmek iin aadakikomutu altrp sonuca bakalmcurl "http://sms_api/?key=6750ee46da09310b8e668fe3f785e7d4&secret=a3uBxqMKlzFgrSrO3KB6YXWQ2lIwGBRmcbZE5rcHawSfFDsGZ2s1lyLQqJKv3MYv"$ curl "http://API_BASE_URL/?key=8eaa3ca9e32334fa4527e9843598abf9&secret=a3uBxqMKlzSgrSrO3KB6YXWQ3lIwGBRmxbZE5rcHawSfFDsGZ2s1lyLQqJKv3MYv"Eer bilgileri doru ise {"result":true} yantn greceksiniz. Eer yanl ise ya dageersiz ise {"result":"error","errors":[{"error_code":"99","error_text":"Auth Error!"}]} yantn alacaksnz.SMS Gnderimi 3. API arayznden sms gndermek iin aadaki yolu izleyebilirsiniz.Bir numaraya sms gndermeTek SMS gndermek iin aadaki POST verisini isteiniz ile birlikte gndermelisiniz. stekgndereceiniz adres yolu /sms/send/singlePost verisi:{"numbers": "","text": "","originator": "","time": "","turkish_character": "",}Bunun iin rnek bir Curl sorgusu aadaki gibidir.$ curl -XPOST --data 'data={"numbers": "5554443322","text": "MesajMetni","originator": "TEST","time": "2014-11-1012:00:00","turkish_character":"0"}' "http://API_BASE_URL/sms/send/single?key=8eaa3ca9e32334fa4527e9843598abf9&secret=a3uBxqMKlzSgrSrO3KB6YXWQ3lIwGBRmxbZE5rcHawSfFDsGZ2s1lyLQqJKv3MYv"Bu sorguyu altrdnzda ise aadaki gibi bir yant alrsnz.{"result":true,"message_id":"74","total_numbers_count":1,"turkcell_numbers_count":0,"vodafone_numbers_count":0,"avea_numbers_count":1,"total_credit":1}Eer bir hata oluursa hatal yant u ekilde olacaktr.{"result":false,"errors":[{"error_code":"232","error_text":"Originator isnot valid!"}]}Bu hatada balk bilgisi daha nceden kaydedilmemi bir balk ile sms gnderilmeyeallmtr. ve hata ile karlalmtr.Gnderilecek verinin ve alnan cevabn dzgn hali aadaki gibidir.Post verisi: 4. {"numbers": "5554443322","text": "Mesaj Metni","originator": "TEST","time": "2014-11-10 12:00:00","turkish_character": "0"}Sonu verisi:{"result": true,"message_id": "74","total_numbers_count": 1,"total_vodafone_count": 0,"total_turkcell_count": 0,"total_avea_count": 1,"total_credit": 1}oklu numaraya ayn sms'i gndermeAyn api yolu ile daha fazla numaraya SMS gnderebilirsiniz. Bunun iin tek yapmanzgereken numbers alanna birden fazla numara gndermektir. Aadaki gibi bir veriyi POSTverisi olarak gnderebilirsiniz.{"numbers": ["5554443322", "5553334433", "5554433221"],"text": "Mesaj Metni","originator": "TEST","time": "2014-11-10 12:00:00","turkish_character": "0"}Sonu verisi olarak yine ayn sonu dnecektir. 5. {"result": true,"message_id": "75","total_numbers_count": 3,"total_vodafone_count": 0,"total_turkcell_count": 0,"total_avea_count": 3,"total_credit": 3}Birden fazla sms'i ayn istekte gndermekBunun iin API arayznden /sms/send/multi yolunu kullanabilirsiniz. Bunun iinsorgunuzun POST verisi aadaki gibi olmaldr.[{"numbers": "5554433221","text": "Mesaj Metni 2","originator": "TEST","time": "2014-11-10 12:00:00","turkish_character": "0"},{"numbers": "5554443322","text": "Mesaj Metni 1","originator": "TEST","time": "2014-11-10 12:00:00","turkish_character": "0"}]Bu istek iin eer bir hata olumaz ise aadaki gibi bir cevap alacaksnz. 6. {"result": true,"results":[{"result": true,"message_id": "76","total_numbers_count": 1,"total_vodafone_count": 0,"total_turkcell_count": 0,"total_avea_count": 1,"total_credit": 1}],[{"result": true,"message_id": "77","total_numbers_count": 1,"total_vodafone_count": 0,"total_turkcell_count": 0,"total_avea_count": 1,"total_credit": 1}]}Balklar ListelemeBalklar listelemek iin /originator/list yolunu kullanabilirsiniz. Bu istek size aadakigibi bir sonu dnecektir.Kredi sorgulama ve Kullanc bilgilerine eriimBu bilgiye erimek iin /user/info yoluna GET isteinde bulunabilirsiniz. Bu API istei sizeiki trl cevap dnebilir. Eer doru key ve secret ile eriim salad iseniz aadaki gibi bircevap alrsnz. 7. {"result":true,"data":{"firstname":"","lastname":"","username":"","email":"","image":"","credit":""}}Eer yanl bilgiler ile armaya alrsanz{"result":"error","errors":[{"error_code":"99","error_text":"Auth Error!"}]}Byle bir yant alrsnz.Rapor SorgulamaSon raporlarnz sorgulamak iin /sms/report/sent yolunu kullanabilirsiniz. Bu API yolusize son gnderdiiniz 20 sms mesajnn kaydn dndrecektir. Aadaki rnee bakarakdnecek sonu hakknda daha fazla bilgiye ulaabilirsiniz. 8. {"result": true,"data": [{"id": "74","created_datetime": "2014-11-10 11:37:44","originator": "TEST","originator_id": "1","total_num": "1","pieces": "1","total_sent": "0","total_out": "0","num_not_reached": "0","num_waiting_for_time": "0","text": "Mesaj Metni"},{"id": "73","created_datetime": "2014-11-08 12:01:06","originator": "TEST","originator_id": "1","total_num": "3","pieces": "1","total_sent": "0","total_out": "0","num_not_reached": "0","num_waiting_for_time": "0","text": "ert"},....{"id": "75","created_datetime": "2014-11-06 10:55:28","originator": "TEST","originator_id": "1","total_num": "1","pieces": "1","total_sent": "0","total_out": "0","num_not_reached": "0","num_waiting_for_time": "0","text": "Test Metni"}],"totals": {"total_message": "73","total_sms": "12150"}} 9. Rapor Detayn incelemeRapor detaylarna ulamak iin ise rapor iin{"result": true,"data": [{"id": "12123","created_datetime": "2014-11-10 11:37:44","gsm_no": "5554443322","gsm_operator": "3","sent_status": "0","sent_datetime": null,"out_status": "0","out_datetime": null,"report_message": null}],"totals": {"total_number": "1"}}PHP rnek Snf ve KullanmBunun iin rnek bir PHP snf oluturduk. Bu snf kullanarak API arayzne daha rahatulaabilirsiniz.