apı dökümanı

TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON
SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
2016 V.1.0
0 1
/
1 1
/
2 0 1 6
powered by Doğan Erdurak
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
İçindekiler
SMS Platform Api’s Dökümantasyonu
1
Api Login
1
Api SMS Gönderim
1
Api SMS Gönderim Genel Rapor
2
Api SMS Gönderim Detay Rapor
3
PHP code example
4
KARAKTER VE SMS PARÇA HESAPLAMA
Tek Parçalı SMS gönderim karakter sınırı ve hesaplama
5
5
1- Türkçe Karakter Olmadan :
5
2- Türkçe Karakterli Gönderimlerde
6
3- Türkçe Karakter Dışındaki özel sembol kullanımlarında
6
4- Diğer sembolik dillerde gönderim
6
1 'den Çok Parçalı SMS gönderim karakter sınırı ve hesaplama
6
1- Türkçe Karakter Olmadan
6
2- Türkçe Karakterli Gönderimlerde
6
3- Türkçe Karakter Dışındaki sembol kullanımlarında
7
4- Diğer sembolik dillerde gönderim
7
powered by Doğan Erdurak
sayfa 1
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
SMS Platform Api’s Dökümantasyonu
Api Login
Token : size verilen token kodu ( 4d697f839d94ec05d80c7be604b26380 )
Key Code : size verilen key kodu ( 46ed906e276826788464c2a685d9a33b )
Token ve Key bilgisi her api isteğinde gönderilmesi gerekiyor.
Aşağıdaki örneklerde de bu bilgi mevcut. Tüm genel api isteklerinde “allow” değer olarak “false” dönüyor
ise hatalı istek yapılıyor demektir.
Örnek :
Url : http://api.teknoklas.com.tr/login/
Gönderilecek Parametreler
token : size verilen token kodu
key_code : size verilen key kodu
user : String ( UTF-8 ) kullanıcı adı (size verilen username)
password : String ( Utf-8 ) Şifre
(size verilen password)
Response
allow : true
response_code : CR_4001
response_description : Login successfull / Login başarılı
allow : false
response_code : CR_4002
response_description : Login başarısız
Api SMS Gönderim
token : size verilen token kodu
key_code : size verilen key kodu
user : String ( UTF-8 ) kullanıcı adı
password : String ( UTF-8 ) Şifre
msisdn : Integer msisdn numarası
receiver_list : Array( telno1, telno2, telno3 ... ) mesajın gönderileceği telefon numaralarının listesi.
title : String ( UTF-8 ) gönderim başlığı ( alfanumerik başlık )
message : String ( UTF-8 ) mesaj içeriği
start_date : String ( date/time ) – Format ( Yıl-Ay-Gün Saat:Dakika ) – ( Timezone : UTC +2 )
gönderim başlangıç tarihi
end_date : String ( date/time ) – Format ( Yıl-Ay-Gün Saat:Dakika ) – ( Timezone : UTC +2 )
powered by Doğan Erdurak
sayfa 2
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
gönderim bitiş tarihi (gönderim bitiş tarihi gönderim başlangıç tarihinden 1 gün sonrası olarak belirtilmeli
Çoklu gönderim yapılacağı zaman kullanım şekli / gönderilecek parametreler farklı olarak şu şekilde
olmalıdır .
receiver_list : Array( telno1~~AD~~SOYAD, telno2~~AD2~~SOYAD2 ... )
message : Merhaba &1 &2, iyi günler dileriz.
*&1 ve &2 mesaj içeriğinde değişkenlerdir. ( 4 taneye kadar kullanılabilir ) bu değişkenler alıcı telefon
listesindeki ( receiver_list ) “~~” ile ayrılmış kısımları alarak kullanır.
**receiver_list içindeki data yapısı her bir hücre içinde telefon numarasından her bir değişken alanı için
“~~” işareti eklenerek kullanılır.
Örnek :
Url : http://api.teknoklas.com.tr/v1.0/sendsms
Response
allow : true
package_id : XXX ( bu sms paket değeri ile daha sonra raporlar çekilecek )
response_code : SMS_5001
response_description : SMS send request successfull / SMS gönderim talebi başarılı
allow : true
response_code : SMS_5002
response_description : SMS send request error / SMS gönderim talebi hatalı
Api SMS Gönderim Genel Rapor
token : size verilen token kodu
key_code : size verilen key kodu
user : String ( UTF-8 ) kullanıcı adı
password : String ( Utf-8 ) Şifre
package_id : Integer sms gönderimi sonrasında alınan response ( package_id )
Örnek :
Url : http://api.teknoklas.com.tr/v1.0/reports/general
Response
powered by Doğan Erdurak
sayfa 3
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
allow : true
total_receivers : ( toplam alıcı / telefon numarası )
total_success : ( başarılı gönderim adedi )
total_unsuccess : ( başarısız gönderim adedi )
total_wait : ( bekleyen gönderim adedi )
total_duplicate ( duplike / tekrar eden alıcı )
start_date : ( başlangıç tarihi )
end_date : (bitiş tarihi)
status_change_time ( paket durumu son değişiklik tarihi )
status : ( 0: kuyrukta / 1: gönderiliyor / 2: tamamlandı / 3: gönderilemedi / 4: pause / 5: cancel / 6:delete )
response_code : RP_12001
response_description : Report request successfull / Rapor talebi başarılı
allow : false
response_code : RP_12002
response_description : Wrong SMS Package ID / Hatalı sms paket kodu
Api SMS Gönderim Detay Rapor
token : size verilen token kodu
key_code : size verilen key kodu
user : String ( UTF-8 ) kullanıcı adı
password : String ( Utf-8 ) Şifre
package_id : Integer sms gönderimi sonrasında alınan response ( package_id )
Örnek :
Url : http://api.teknoklas.com.tr/v1.0/reports/detail
Response
allow : true
package_id : paket id
receiver : alici / telefon numarası
alphanumeric_title: alfanumerik başlık
operator : ( 1: turkcell / 2: vodafone / 3: avea )
sms_count : sms adedi
sms_cost : birim ücret
powered by Doğan Erdurak
sayfa 4
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
end_date : bitiş tarihi
status : ( 0 : beklemede / 1: iletildi / 2: işlemde / 3: tekrar gönderilecek / 4: hatalı )
error_code: Gönderimlerdeki hata kodu alanıdır
error_description : Gönderimlerde ki hata kodu açıklama alanıdır
response_code : RP_13001
response_description : Report request successfull / Rapor talebi başarılı
allow : false
response_code : RP_13002
response_description : Wrong SMS Package ID / Hatalı sms paket kodu
PHP code example
<?php
// SEND SMS EXAMPLE
$data = array(
'title'=>'HEPGSMDEMO',
'msisdn'=>'8504170289',
'message'=>'SMS İÇERİĞİ',
'start_date'=>'2015-05-01 12:00',
'end_date'=>'2015-05-02 12:00',
'keycode'=>'XXXXXX',
'token'=>'XXXXXX',
'user'=>'XXXXXX',
'password'=>'XXXXXX',
'receiver_list' => array(
);
)
'905XXXXXXX','905XXXXXXX','905XXXXXXX','905XXXXXXX'
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://api.teknoklas.com.tr/v1.0/sendsms");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch, CURLOPT_TIMEOUT, 300);
$result = curl_exec($ch);
// PACKAGE GENERAL REPORT EXAMPLE
$data = array(
'keycode'=>'XXXXXX',
'token'=>'XXXXXX',
'user'=>'XXXXXX',
'password'=>'XXXXXX',
'package_id' => 'XXXXXX'
powered by Doğan Erdurak
sayfa 5
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://api.teknoklas.com.tr/v1.0/reports/general");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch, CURLOPT_TIMEOUT, 300);
$result = curl_exec($ch);
// PACKAGE DETAIL REPORT EXAMPLE
$data = array(
'keycode'=>'XXXXXX',
'token'=>'XXXXXX',
'user'=>'XXXXXX',
'password'=>'XXXXXX',
'package_id' => 'XXXXXX'
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"http://api.teknoklas.com.tr/v1.0/reports/detail");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch, CURLOPT_TIMEOUT, 300);
$result = curl_exec($ch);
?>
KARAKTER VE SMS PARÇA HESAPLAMA
Tek Parçalı SMS gönderim karakter sınırı ve hesaplama
1- Türkçe Karakter Olmadan :
Gönderim max. karakter sayısı (Her 1 sms metni için ) :
160 karakter (ö - Ö - Ç dahil - türkçe karakter kabul edilmez)
2- Türkçe Karakterli Gönderimlerde :
Gönderim max. karakter sayısı (Her 1 sms metni için ) :
155 karakter ( Ş - ş -Ğ - ğ - İ - ı dahil , türkçe karakter kabul edilir)
powered by Doğan Erdurak
sayfa 6
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
3- Türkçe Karakter Dışındaki özel sembol kullanımlarında
Gönderim max. karakter sayısı (Her 1 sms metni için ) : 155 karakter (€ - | - ~ - \ - [ - ] - { - } dahil sembol
karakter kabul edilir)
Bu özel karakterlerin kullanıldığı SMS metninde 155 toplam gönderim sınırından her 1 adet türkçe
karakter için de 2 karakter düşer .
Örnek :
metin: aaaaa12345€şşşşş :
toplam karakter sayısı :
( 5 adet a = 5 karakter ) + ( 5 adet rakam = 5 karakter ) + ( 5 adet ş + 1 adet € = 12 karakter )= 22 karakter
toplamı şeklinde kullanılır ;
Eğer € karakteri olmasaydı 2 . madde de belirtildiği gibi her bir rakam ve harf 1 karakter ile hesaplanarak
toplam 15 karakter olarak hesaplanacaktı.
4- Diğer sembolik dillerde gönderim
Arapça ; çince veya kiril alfabesiyle gönderimlerinizde
Gönderim max. karakter sayısı (Her 1 sms metni için ) : 70 karakter ( Diğer tüm karakter ve sembollerde )
1 'den Çok Parçalı SMS gönderim karakter sınırı ve hesaplama
1- Türkçe Karakter Olmadan :
Gönderim max. karakter sayısı (Her sms metni için ) : 153 karakter (ö - Ö - Ç dahil - türkçe karakter kabul
edilmez)
Örnek :
353 karakterlik türkçe karakter kullanılmayan bir metin : 353/153 = 2.3 yani
153 (1. mesaj metni parçası) + 153 (2. mesaj metni parçası) + 47 (3. mesaj metni parçası) = 353 toplam 3
adet parçadan oluşur SMS metni.
2- Türkçe Karakterli Gönderimlerde
Gönderim max. karakter sayısı (Her sms metni için ) : 149 karakter ( Ş - ş -Ğ - ğ - İ - ı dahil , türkçe karakter
kabul edilir)
Örnek :
353 karakterlik türkçe karakter kullanılan bir metin : 353/149 = 2.36 yani
149 (1. mesaj metni parçası) + 149 (2. mesaj metni parçası) + 55 (3. mesaj metni parçası) = 353 toplam 3
adet parçadan oluşur SMS metni.
powered by Doğan Erdurak
sayfa 7
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
Örnek :
353 karakterlik türkçe karakter kullanılan bir metin : 353/149 = 2.36 yani149 (1. mesaj metni parçası) + 149
(2. mesaj metni parçası) + 55 (3. mesaj metni parçası) = 353 toplam 3 adet parçadan oluşur SMS metni.
3- Türkçe Karakter Dışındaki sembol kullanımlarında
Gönderim max. karakter sayısı (Her sms metni için ) :
155 karakter (€ - | - ~ - \ - [ - ] - { - } dahil - sembol karakter kabul edilir)
Bu özel karakterlerin kullanıldığı SMS metninde her bir parça için 149 toplam gönderim sınırından her 1
adet türkçe karakter için 2 karakter düşer .
Örnek :
353 karakterlik özel karakter € veya diğerlerinden kullanılan bir metin :
* türkçe olmayan karakter 300 adet olsun
** türkçe olan karakter
10 adet olsun
*** Özel olan karakter
43 adet olsun
toplam karakter sayısını bulalım :
( 300 adet türkçe olmayan karakter = 300 karakter ) +
( 10 adet türkçe karakter * 2 = 20 karakter ) + ( 43 adet özel karkter * 2 = 86 karakter )
= 406 karakter toplamı şeklinde kullanılır ;
149 (1. mesaj metni parçası) + 149 (2. mesaj metni parçası) + 108 (3. mesaj metni parçası) = 406 toplam 3
adet parçadan oluşur SMS metni.
Eğer € karakteri olmasaydı 2 . madde de belirtildiği gibi her bir rakam ve harf 1 karakter ile hesaplanarak
toplam 15 karakter olarak hesaplanacaktı.
4- Diğer sembolik dillerde gönderim
Arapça ; çince veya kiril alfabesiyle gönderimlerinizde
Gönderim max. karakter sayısı (Her sms metni için ) : 63 karakter ( Diğer tüm karakter ve sembollerde )
powered by Doğan Erdurak
sayfa 8
TEKNOKLAS İLETİŞİM TELEKOMÜNİKASYON SANAYİ VE TİCARET LİMİTED ŞİRKETİ
SMS iNTERCONNECION APi’S DOKÜMANI
Örnek :
powered by Doğan Erdurak