API ile ilgili bilgiler şu şekildedir:
http://api2.ekomesaj.com/metadata
SMS gönderimi için öncelikli olarak acil olan metod:
http://api2.ekomesaj.com/xml/metadata?op=SendInstantSms
POST Adresi: api2.ekomesaj.com/xml/syncreply/SendInstantSms
veya alternatif:
http://api2.ekomesaj.com/json/metadata?op=SendInstantSms
POST Adresi: api2.ekomesaj.com/json/syncreply/SendInstantSms
Hızlı entegrasyon için aşağıdaki şablon kullanılabilir:
{"Credential":{"Username":"xxxxxxxx","Password":"xxxxxxxx","ResellerID":2050},
"Sms":{
"ToMsisdns":[
{"Msisdn":905xxxxxxxxx,"Name":"","Surname":"","CustomField1":""}
],
"ToGroups":[],
"IsCreateFromTeplate":false,
"SmsTitle":"xxxxxxxx",
"SmsContent":"xxxxxxxxxxxxxxx",
"RequestGuid":"",
"CanSendSmsToDuplicateMsisdn":false,
"SmsSendingType":"ByNumber",
"SmsCoding":"String",
"SenderName":"xxxxxxxxx",
"Route":0,
"ValidityPeriod":0,
"DataCoding":"Default"}
}
xxxxxx yazan yerleri müşteri bilgileri ile doldurabilirsiniz; kullanıcı adı şifre vs...
Username: Kullanıcı adı.
Password: Şifre.
Reseller id: 2050 (Bu kod olmadan API çalışmaz. Kullanıcı Adı, Şifre hatası verir.)
Sms title: Buraya tercihe göre bir isimlendirme yapılabilir. ("Ahmet'in Mesajı", "Mehmet'in gönderimi" vb...)
Sms content: Mesaj metni.
Sender name: Gönderen başlığı.
Diğer değerler olduğu gibi bırakılabilir.
Eğer aynı paket içerisinde her numaraya farklı mesaj gönderilmek istenilirse;
{"Credential":{"Username":"xxxx","Password":"xxxx","ResellerID":2050},
"Sms":{
"ToMsisdns":[
{"Msisdn":905xxxxxxxxx,"Name":"","Surname":"","CustomField1":"[Mesaj1]:Merhaba."},
{"Msisdn":905xxxxxxxxx,"Name":"","Surname":"","CustomField1":"[Mesaj1]:Nasılsın?"}
],
"ToGroups":[],
"IsCreateFromTeplate":true,
"SmsTitle":"xxxx",
"SmsContent":"[Mesaj1]",
"RequestGuid":"",
"CanSendSmsToDuplicateMsisdn":false,
"SmsSendingType":"ByNumber",
"SmsCoding":"String",
"SenderName":"xxxx",
"Route":0,
"ValidityPeriod":0,
"DataCoding":"Default"}
}
Rapor sorgulaması için aşağıdaki şablonu kullanabilirsiniz:
{"Credential":{"Username":"xxxx","Password":"xxxx","ResellerID":2050},"SmsHistoryID":xxxx,"StartPage":0,"PageSize":20}
Burada dikkat edilmesi gereken nokta, SmsHistoryID değeri olarak sms gönderiminden sonra dönen response bilgisi içerisindeki MessageID değerinin girilmesidir.
PageSize değeri olarak 0 girilirse 500 hatası alınır, 0'dan farklı bir değer girilmesi gerekmektedir.
Mesaj durumları ile ilgili dönen response bilgisi içerisindeki State değerleri şu şekildedir:
Ana Paket Durum Kodları
0 : Kuyrukta
1 : Gönderildi
2 : İptal Edildi
3 : Gönderiliyor
4 : Mesaj Kabul Edilmedi
5 : Mesaj Alınıyor
6 : Müşteri Kredi/Ödeme Sorunu
7 : Hesap Pasif
Detay Paket (Numara bazlı) Durum Kodları
0 : Zamanlanmış
1 : Gönderilmiş (SMSC'den rapor daha alınamadı)
2 : İletildi
3 : Zaman aşımına uğradı
4 : Silinmiş
5 : İletilmedi
6 : SMSC tarafından alındı
7 : Bilinmiyor
8 : Reddedildi
9 : Hatadan dolayı gönderilmeyecek