SMS Api Dökümanı

Post Edilecek Adres

1
http://www.kobikom.com/api/sendsms/xml/

Sorgu Gönderimi

1
2
3
POST http://www.kobikom.com/api/sendsms/xml/
Host: kobikom.com
Content-Type: application/xml Accept: */*

XML Gönderim Yapısı

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
XML=
<SMS>
<dogrulama>
<kullanici>kullanıcı_adiniz</kullanici>
<parola>kullanici_parola</parola>
</dogrulama>
<mesajiniz>
<baslik>Kobikom</baslik>
<metin>Merhaba</metin>
<flash>1</flash>
<type></type>
<wapurl></wapurl>
<binary></binary>
<datacoding></datacoding>
<esmclass></esmclass>
<srcton></srcton>
<srcnpi></srcnpi>
<destton></destton>
<destnpi></destnpi>
<ileriTarih>4d3h2m1s</ileriTarih>
<ValidityPeriod></ValidityPeriod>
<appid></appid>
<pushurl></pushurl>
<nopush></nopush>
<alicilar>
<gsm>905329975725</gsm>
<gsm></gsm>
<gsm></gsm>
<gsm></gsm>
</alicilar>
</mesajiniz>
</SMS>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
XML=
<SMS>
<dogrulama>
<kullanici>kullanici_adiniz</kullanici>
<parola>kullanici_parola</parola>
</dogrulama>
<mesajiniz>
<baslik>Kobikom</baslik>
<metin>Merhaba</metin>
<flash>1</flash>
<type></type>
<wapurl></wapurl>
<binary></binary>
<datacoding></datacoding>
<esmclass></esmclass>
<srcton></srcton>
<srcnpi></srcnpi>
<destton></destton>
<destnpi></destnpi>
<ileriTarih>4d3h2m1s</ileriTarih>
<ValidityPeriod></ValidityPeriod>
<appid></appid>
<pushurl></pushurl>
<nopush></nopush>
<alicilar>
<gsm
messageId="clientmsgID1">905329975725</gsm>
<gsm
messageId="clientmsgID2">905329975726</gsm>
<gsm
messageId="clientmsgID3">905329975737</gsm>
<gsm
messageId="clientmsgID4">905329975744</gsm>
</alicilar>
</mesajiniz>
</SMS>

Yapı Parametreleri

DoğrulamakullaniciKobikom kullanıcı adınız
parolaKobkom kullanıcı şifreniz
MesajbaslikDinamik mesaj gönderen id
Alphanumeric max.length :11
Numeric max.length: 14
metinMesaj alanı boyut 160 karakter olmalı
Flash0 veya 1 değer alabilir
0 normal SMS send
1 flash SMS acil durumlarda kullanılır
typeSeçimli parametre longSMS
Bos kullanın 160 dan fazla karakter mesajda bu değer kullanılır
wapurlbos
binaryHexdecimal format (boş)
DataCodingDefault : 0
Değer: 8 (Unicode göndderim içn)
EsmclassEsm_class default 0
Srctonbos
Srcnpibos
Desttonbos
Destnpibos
ValidityPeriodValidityPeriod HH:mm maksimum 48 saat olabilir default boş
ileriTarihİleri gönderimli kullanım
4 day, 3 hours, 2 minute, 1 second,
Anlık göndeim için 1s olmalı
appidboş
pushurlBoş durumda nopush
nopushDefault değer 0 dır boş bırakınız
AlıcılarGSMMesaj kime gönderilecek +, 0 uluslararası gönderim için kullanımı
GSM
messageId=“clientmsgID“
Kayıt teslimi – “messageID” müşteri tarafından belirlenen 6

Geri dönüş XML

1
2
3
4
5
6
7
8
9
10
11
12
13
Status Code: 200
Content-Type: text/csv;charset= UTF-8
Content-Length: 176
Date: Tue, 22 May 2012 12:28:38 GMT
<?xml version="1.0" encoding="UTF-8"?>
<results>
<result>
<status>0</status>
<messageid>Kobikom_MessageId
değeri</messageid>
<destination>905329975725</destination>
</result>
</results>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Status Code: 200
Content-Type: text/csv;charset= UTF-8
Content-Length: 277
Date: Tue, 22 May 2012 12:28:50 GMT
<?xml version="1.0" encoding="UTF-8"?>
<results>
<result>
<status>0</status>
<messageid>sizinmsgID1</messageid>
<destination>905329975725</destination>
</result>
<status><0</status>
<messageid>sizinmsgID2</messageid>
<destination>905329975726</destination>
</result>
</results>

Kısa Mesaj Hızlı Gönderim

1
2
3
4
Request
POST http://www.kobikom.com/api/sendsms/xml/
Host: kobikom.com
Content-Type: application/xml Accept: */*

1
2
3
4
5
6
7
8
9
10
11
12
13
14
XML=
<SMS>
<dogrulama>
<kullanici>test</kullanici>
<parola>test</parola>
</dogrulama>
<mesajiniz>
<baslik>Kobikom</baslik>
<metin>Merhaba</metin>
<alicilar>
<gsm>905352220087</gsm>
</alicilar>
</mesajiniz>
</SMS>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
XML=
<SMS>
<dogrulama>
<kullanici>test</kullanici>
<parola>test</parola>
</dogrulama>
<mesajiniz>
<baslik>Kobikom</baslik>
<metin>Merhaba</metin>
<alicilar>
<gsm>905352220087</gsm>
<gsm>905352220054</gsm>
<gsm>905322542525</gsm>
</alicilar>
</mesajiniz>
</SMS>

Hata ve Gönderim Kodları

0Tüm işlemler başarılı
-1Gönderim başarısız
-2Hesapta yeterli kredi yok
-3Hedeflenen ağ kapsamında değil
-5Kullanıcı adı ve şifre geçersiz
-6Gönderim numarasında eksiklik
-10Kullanıcı Adı hatalı
-11Parola hatalı
-13 Bilinmeyen gönderim numarası KobiKom dışı gönderim operatörü
-22XML syntax error hata
-23Genel hata
-26API baglanti hatası
-27İleri gönderim tarih hatası
-33Birden fazla MessageID durum hatası
-34Mesaj iletilemedi
-99 Birden çok gönderim hatası nedeni ?

İleti Raporu Almak

ÇOK ÖNEMLİ: İletim raporu yöntemi kullanırken sadece bir kez sonuç görüntülenir, rapor sonucu tekrar gösterilmez eğer tekrar rapor görmek istenilirse sonuç NO_DATA olarak dönecektir.

1.1.1 Sorgu Gönderimi

1
2
3
GET http://www.kobikom.com/api/sendsms/xml/pull?
Host: kobikom.com
Content-Type: application/xml Accept: */*

– HTTP GET yöntemi ile URL teslim raporları almak için

1
http://www.kobikom.com/api/sendsms/xml/pull?kullanici=test&parola=test1

Parametreler:

  • Kullanıcı
  • Parola
  • MessageId / isteğe bağlı, belirli iletim raporlarını istemek için. Virgül ile ayırarak birden fazla değer isteme olasılığı.

Dönüş Değerleri :

  • 5 – Geçersiz kullanıcı adı veya şifre
  • 10 – Eksik Kallanıcı Adı hatası
  • 11 – Eksik Şifre Hatası

1.1.2 Sizin oluşturduğunuz Message ID ile gönderim raporunuz

1
2
3
4
5
6
7
<DeliveryReport>
<message id="1000" sentdate="2010/8/2 14:55:10"
donedate="2010/8/2 14:55:16" status="DELIVERED" gsmerror="0"
/>
<message id="1002" sentdate="2010/8/2 14:55:10"
donedate="2010/8/2 14:55:16" status="DELIVERED" gsmerror="0"
/>

1.1.3 KobiSMS oluşturma raporunuz

1
2
3
4
<DeliveryReport>
<message id="1023012301" sentdate="2005/7/19 22:0:0"
donedate="2005/7/19 22:0:0" status="NOT_SENT" gsmerror="0" />
</DeliveryReport>
idKullanıcı özel veya KobiSMS mesaj id
senddateMesaj gönderim zaman başlangıcı format(yyyy/m/d hh:mm:ss)
donedateMesaj gönderim bitiş zaman aralığı format(yyyy/m/d hh:mm:ss)
statusNOT_SENTMesaj KobiSMS kuyruğunda ancak teslim edilemedi
SENTMesaj rapor desteği vermeyen alan üzerinden gönderldi.
NOT_DELIVEREDMesaj teslim edilemedi.
DELIVEREDMesaj alıcıya başarı ile iletildi.
NOT_ALLOWEDŞebekeye göndermek için yetki ?
INVALID_DESTINATION_ADDRESSGeçersiz / Yanlış GSM Operatör No
INVALID_SOURCE_ADDRESSYanlış / Geçersiz / Kaynak Adres
ROUTE_NOT_AVAILABLEGönderim geçerli alanda değildir.
NOT_ENOUGH_CREDITSKullanılabilir krediniz hesabınızda tükendi
REJECTEDDeğişik sebeplerden rededlidi.
INVALID_MESSAGE_FORMATMesajınız geçersiz biçimdedir.

Başlık Sorgulama

1
2
3
4
Request
POST http://www.kobikom.com/api/sendsms/xml/
Host: kobikom.com
Content-Type: application/xml Accept: */*
1
2
3
4
5
6
<basliklar>
    <dogrulama>
        <kullanici>KULLANICI ADI</kullanici>
        <parola>ŞİFRE</parola>
    </dogrulama>
</basliklar>

Geri Dönüş XML

1
2
3
4
5
6
7
8
<?xml version="1.0" encoding="UTF-8"?>
<basliklar>
    <normal>
        <baslik>TEST</baslik>
        <baslik>DEMO</baslik>
    </normal>
    <sayisal></sayisal>
</basliklar>

Bakiye Sorgulama

1
2
3
4
5
6
7
8
<?xml version="1.0" encoding="UTF-8"?>
<basliklar>
    <normal>
        <baslik>TEST</baslik>
        <baslik>DEMO</baslik>
    </normal>
    <sayisal></sayisal>
</basliklar>