API Dokümanları
RAPORLAMA METOTLARI
1. /api /OtpReport /GetReportByPackAgeId
Bu fonksiyon mesaj ID bilgisi verilen mesaj paketine dair detay bilgisini döner. Mesajın OTP SMS olarak gönderilmiş olması gerekmektedir.
https://restapi.ttmesaj.com/api/OtpReport/GetReportByPackAgeId
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| Header | Authorization | Bearer access_token bilgisi | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| packageId | string | SMS sağlayıcı tarafından verilen mesaj ID değeri bilgisidir. Zorunlu bir alandır. | ||
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx"
"packageId": "2018072821535420459",
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Tip | Açıklama |
|---|---|
| string | Mesajla ilgili tüm detaylar string içerisinde dönmektedir. Servis cevabı içerisindeki parametreler aşağıda açıklanmıştır. |
Mesajla ilgili servisten gönderilen değerler aşağıdaki gibidir:
| Ad | Açıklama |
|---|---|
| PackageId | Raporu sorgulanan mesajın paket ID değeridir. |
| Id | Mesajın ID değeridir. |
| Number | Mesajın gönderildiği telefon numarasıdır. |
| Origin | Mesajın gönderildiği başlık bilgisidir. |
| MessageText | Gönderilen mesaj metni bilgisidir. |
| ServiceDeliveryTime | Mesajın gönderildiği tarih bilgisidir. |
| EndUserDeliveryTime | Mesajın kişinin telefonuna iletildiği tarih bilgisidir. |
| Status | Mesajın durum kodunu gösterir. |
| StatusDescription | Mesajın durum açıklamasıdır. |
| ResponseCode | Gönderilen mesajın durum kodunu gösterir. Durum kodları aşağıda belirtilmiştir. |
| ResponseDescription | Gönderilen mesajın durum açıklamasıdır. Durum açıklamaları aşağıda belirtilmiştir. |
| OnsimChangeSendCode | Gönderilen mesajın dönüş kodudur. Dönüş kodları aşağıda belirtilmiştir. |
| OnsimChangeSendCodeDesc | Gönderilen mesajın dönüş açıklamasıdır. Dönüş açıklamaları aşağıda belirtilmiştir. |
Json Response örneği aşağıdaki gibidir:
"[{"PackageId":"2018072821535420459", "Id":"", "Number":"905XXXXXXXXX ","Origin":" ORNBASLIK", "MessageText":" Ornek mesaj metni ", "ServiceDeliveryTime":"06.06.2022 14:55:07", "EndUserDeliveryTime":"06/06/2022 14:55:08", "Status":"12", "StatusDescription":"Mesaj aboneye iletildi-DELIVRD-000-Basarili", "ResponseCode":0, "ResponseDescription":"DELIVRD 000 Basarili ", "OnsimChangeSendCode":"0", "OnsimChangeSendCodeDesc":"SMS gonderilmek icin mesaj merkezine iletildi (AVEA)" }]"
Status ve StatusDescription parametrelerinin alabileceği değerler ve açıklamaları aşağıdaki gibidir:
| Status Değeri | StatusDescription Değeri |
|---|---|
| 3 | Verilen mesaj ID sine ait rapor bulunamadı |
| 2 | Verilen tarih aralığında rapor bulunamadı |
| 0 | Herhangi bir hata yok |
| -1 | Sistem hatası |
| -2 | İşlemi yapmak için yetkiniz yok |
| -3 | Sisteme Belirlenen aralıklardan daha sık erişim yaptınız |
| -4 | Kontörünüz yetersiz |
| -5 | Limit Yetersiz |
| -6 | Hesabınız pasif durumda |
| -10 | Kullanıcı Bilgileri Yanlış |
| -11 | Origin hatalı |
| -12 | Mesaj metnini kontrol ediniz |
| -13 | Mesaj metni 612 karakterden fazla olamaz |
| -14 | XML formatı hatalı |
| -15 | Tarih formatı hatalı |
| -16 | Geçerli numara yok |
| -17 | EndDate SendDate tarihinden önce olamaz |
| -18 | SendDate ile Enddate tarihleri arasında en az 1 saat olmalı |
| -20 | Tarih formatı hatalı |
| -21 | Tarih aralığı çok kısa |
| -30 | Tarih aralığı çok kısa |
| -31 | En fazla 3 ay önceki mesaj paket raporu çekebilirsiniz |
ResponseCode ve ResponseDescription parametrelerinin alabileceği değerler ve açıklamaları aşağıdaki gibidir:
| ResponseCode Değeri | ResponseDescription Değeri |
|---|---|
| 000 | Basarili. |
| 001 | Bilinmeyen Numara. |
| 002 | Bilinmeyen Numara. |
| 004 | Abone SMS servisini desteklemiyor. |
| 005 | Abone Mesaj Alimina Kisitli. |
| 007 | Cihaz SMS alimini desteklemiyor. |
| 008 | Abone Kapsama Alani Disinda. |
| 009 | Abone kapsama alani disinda. |
| 010 | Sistem Hatasi. |
| 011 | Abone mesaj kuyrugu dolu. |
| 012 | Abone isletim sistemi hatasi. |
| 013 | Abone Mesaj Alimina Kisitli. |
| 014 | Sistem Hatasi. |
| 015 | Telefon Kaynakli Problem. |
| 016 | Telefon Kaynakli Problem. |
| 017 | Telefon Mesaj Hafizasi Dolu. |
| 020 | SME(bağlı olduğu operatör ile iletişime geçmeli) Adresi hatali. |
| 022 | Gecersiz cihaz. |
| 023 | Telefon Isletim Sistemi Mesgul. |
| 024 | Hat Kapali. |
| 027 | Kapali ya da kapsama alani disinda abone. |
| 031 | Abone meşgul. |
| 032 | Cihaz Mesaj Hafizasi Dolu. |
| 034 | Sistem Hatasi. |
| 036 | Sistem Hatasi. |
| 040 | Sistem Hatasi. |
| 041 | Sistem Hatasi. |
| 048 | Sistem Hatasi. |
| 051 | Sistem Hatasi. |
| 052 | Sistem Hatasi. |
| 056 | Sistem Hatasi. |
| 057 | Sistem Hatasi. |
| 061 | Sistem Hatasi. |
| 062 | Sistem Hatasi. |
| 063 | Sistem Hatasi. |
| 065 | Sistem Hatasi. |
| 075 | Abone bulunamadi. |
| 3 | Yetkisiz abone. |
| 35 | Sistem Hatasi. |
| 98 | SMS Cikis adresi hatali. |
| 255 | Sistem Hatasi. |
| 1058 | Sistem Hatasi. |
| 1078 | Hatali Numara. |
| 1229 | Sistem Hatasi. |
| 4101 | Sistem Hatasi. |
| 4104 | Sistem Hatasi. |
| 4107 | Sistem Hatasi. |
| 4108 | Sistem Hatasi. |
| 4109 | Sistem Hatasi. |
| 4115 | Sistem Hatasi. |
| 4121 | Sistem Hatasi. |
| 4124 | Sistem Hatasi. |
| 4352 | Sistem Hatasi. |
| 4354 | Sistem Hatasi. |
| 4366 | Sistem Hatasi. |
| 4367 | Hatali Numara. |
| 4369 | Sistem Hatasi. |
| 4370 | Sistem Hatasi. |
| 8219 | Mesaj suresi doldu. |
| 8237 | Message Expired. |
OnsimChangeSendCode ve OnsimChangeSendCodeDesc parametrelerinin alabileceği değerler ve açıklamaları aşağıdaki gibidir:
| OnsimChangeSendCode Değeri | OnsimChangeSendCodeDesc Değeri |
|---|---|
| 0 | SMS gonderilmek icin mesaj merkezine iletildi |
| 1 | Kullanıcı adı/Parola yanlış |
| 2 | IP tanımlı değil |
| 3 | Hatali gsmno formati. Gsm No: 90(Turkiye) yada 00(Yurtdisi) ile baslamali ve min 8 karakter olmalidir |
| 4 | SMS icerigi 160 karakterden fazla/bos olamaz. |
| 5 | MessageId hatali |
| 6 | Header sistemde tanimli degil |
| 7 | Hatali duration parametresi |
| 8 | SMS gonderilecek numara TURK TELEKOM numarasi degil |
| 9 | SMS gonderilecek numara sim kart degisikligi yapmistir < SIMCARDCHANGEDATE >;yyyyMMddHHmm < / SIMCARDCHANGEDATE > |
| 10 | CheckDate parametresi hatali. Ornek:(23122009172105) |
| 11 | OnnetSimChange parametresini gonderme/gondermeme yetkinizi kontrol ediniz (kmh yetki veriyor) |
| 12 | Saniyede gonderebileceginiz SMS limiti asildi |
| 13 | Gonderilen Toplu SMS sayisi limitin ustunde |
| 14 | Lutfen XML icerigini kontrol ediniz |
| 15 | Sms gonderilecek numara, numara tasima islemi yapmistir. < PORTINDATE >yyyyMMddHHmm< / PORTINDATE > |
| 16 | PortinCheckDate parametresi hatali. Örnek:(23122009172105) |
| 17 | Şifrelenmiş Mesaj Açılamadı |
| 19 | CheckDate sim kart degisim tarihinden once olamaz |
| 20 | CheckDate Sms gonderim tarihinden sonraki bir tarihte olamaz |
| 21 | Port-in CheckDate Sms gonderim tarihinden sonraki bir tarihte olamaz |
| 29 | Hattın durumu SMS gönderimine uygun değildir. |
| -1 | Sistem hatası |
| 50 | Kullanici adi/parola yanlis |
| 51 | Date parametresi hatali ya da gunun tarihinden sonraki bir tarih. Ornek:(23122009) |
| 52 | MesajId hatali |
| 53 | MesajId’ler arasindaki fark max 1000 olmalidir |
| 54 | Maksimum gonderebileceginiz mesaj id sayisi 10 olmalidir |
| 55 | Gonderilen messaj id listesi yanlistir. Lutfen kontrol ediniz |
| 34 | ISNOTIFICATION alani bos birakilamaz |
| 35 | Gecersiz ISNOTIFICATION |
| 36 | RECIPIENTTYPE alani bos birakilamaz |
| 37 | Gecersiz RECIPIENTTYPE |
| 38 | BRANDCODE alani bos birakilamaz |
2. /api /SendSmsReport /getSmsDetailFromIDList
Bu fonksiyon mesaj ID bilgisi verilen mesaj paketine dair detay bilgisini döner.
https://restapi.ttmesaj.com/api/SendSmsReport/getSmsDetailFromIDList
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| Header | Authorization | Bearer access_token bilgisi | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| packageId | string | SMS sağlayıcı tarafından verilen mesaj ID değeri bilgisidir. Zorunlu bir alandır. | ||
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx",
"packageId": "2018072821535420459"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Tip | Açıklama |
|---|---|
| string | Mesajla ilgili tüm detaylar string içerisinde dönmektedir. Servis cevabı içerisindeki parametreler aşağıda açıklanmıştır. |
Mesajla ilgili servisten gönderilen değerler aşağıdaki gibidir:
| Ad | Açıklama |
|---|---|
| ServisHata | Servisten gönderilen hata kodlarıdır. |
| Id | Mesajın ID değeridir. |
| PaketId | Raporu sorgulanan mesajın paket ID değeridir. |
| GonderimTarih | Mesajın gönderildiği tarih bilgisidir. |
| UlasimTarih | Mesajın kişinin telefonuna iletildiği tarih bilgisidir. |
| Origin | Mesajın gönderildiği başlık bilgisidir. |
| Alici | Mesajın gönderildiği telefon numarasıdır. |
| MesajUzunluğu | Gönderilen mesajın kaç mesaj uzunluğunda olduğunu gösterir. |
| GonderimDurum | Gönderilen mesajın durum kodunu gösterir. Durum
kodlarının
açıklamaları şu şekildedir: 0 = > Gönderilmek üzere bekleniyor. 1 = > İletildi. 2 = > Rapor bekleniyor. 3 = > Hatalı 4 = > Zaman aşımı 5 = > İptal edildi. |
| GonderimDurumAciklama | Gönderilen mesajın durum açıklamasıdır. |
| Icerik | Gönderilen mesaj metni bilgisidir. |
Json Response örneği aşağıdaki gibidir:
"[{"ServisHata":0, "Id":"XXXXXXXX", "PaketId":"2018072821535420459", "GonderimTarih":"202206101455" ,"UlasimTarih":"202206101455", "Origin":"ORNBASLIK", "Alici":"905XXXXXXXXX", "MesajUzunluğu":1, "GonderimDurum":2, "GonderimDurumAciklama":"SMS gonderilmek icin mesaj merkezine iletildi.(0)", "Icerik":"Ornek mesaj metni" }]"
3. /api /SendSmsReport/ getSmsDetailFromDateAndGsmNumber
Bu fonksiyon belirtilen tarihte telefon numarasına gönderilen mesajların bilgilerini döner.
https://restapi.ttmesaj.com/api/SendSmsReport/getSmsDetailFromDateAndGsmNumber
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| Header | Authorization | Bearer access_token bilgisi | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| smsDate | string | yyyyMMddHHmm | Telefon numarasına ait raporu alınmak istenen tarih. | |
| GsmNumber | string | Raporu alınmak istenen telefon numarası. Yurtdışı numaraları 00 ile başlamalı ve en az 12 karakter olmalıdır. Zorunlu bir alandır. | ||
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx",
"smsDate": "202206101455",
"GsmNumber": "905XXXXXXXXX"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Tip | Açıklama |
|---|---|
| string | Mesajla ilgili tüm detaylar string içerisinde dönmektedir. Servis cevabı içerisindeki parametreler aşağıda açıklanmıştır. |
Mesajla ilgili servisten gönderilen değerler aşağıdaki gibidir:
| Ad | Açıklama |
|---|---|
| ServisHata | Servisten gönderilen hata kodlarıdır. |
| Id | Mesajın ID değeridir. |
| PaketId | Raporu sorgulanan mesajın paket ID değeridir. |
| GonderimTarih | Mesajın gönderildiği tarih bilgisidir. |
| UlasimTarih | Mesajın kişinin telefonuna iletildiği tarih bilgisidir. |
| Origin | Mesajın gönderildiği başlık bilgisidir. |
| Alici | Mesajın gönderildiği telefon numarasıdır. |
| MesajUzunluğu | Gönderilen mesajın kaç mesaj uzunluğunda olduğunu gösterir. |
| GonderimDurum | Gönderilen mesajın durum kodunu gösterir. Durum
kodlarının
açıklamaları şu şekildedir: 0 = > Gönderilmek üzere bekleniyor. 1 = > İletildi. 2 = > Rapor bekleniyor. 3 = > Hatalı 4 = > Zaman aşımı 5 = > İptal edildi. |
| GonderimDurumAciklama | Gönderilen mesajın durum açıklamasıdır. |
| Icerik | Gönderilen mesaj metni bilgisidir. |
Json Response örneği aşağıdaki gibidir:
"[{"ServisHata":0, "Id":"XXXXXXXX", "PaketId":"2018072821535420459", "GonderimTarih":"202206101455" ,"UlasimTarih":"202206101455", "Origin":"ORNBASLIK", "Alici":"905XXXXXXXXX", "MesajUzunluğu":1, "GonderimDurum":2, "GonderimDurumAciklama":"SMS gonderilmek icin mesaj merkezine iletildi.(0)", "Icerik":"Ornek mesaj metni" }]"
4. /api /SendSmsReport/ getSmsDetailFromDateRange
Bu fonksiyon belirtilen tarih aralığında telefon numaralarına gönderilen mesajların bilgilerini döner.
https://restapi.ttmesaj.com/api/SendSmsReport/getSmsDetailFromDateRange
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| Header | Authorization | Bearer access_token bilgisi | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| StartDate | string | yyyyMMddHHmm | Alınmak istenen raporun başlangıç tarihi. | |
| EndDate | string | yyyyMMddHHmm | Alınmak istenen raporun bitiş tarihi. | |
| PageNumber | int | Rapor sonucunda her 1000 adet mesaj için 1 sayfa oluştururlur. Parametreye yazılan değer hangi sayfadaki sonuçların gönderileceğini belirtir. | ||
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx",
"StartDate": "202206101455",
"EndDate": "202206151455",
"PageNumber": 1,
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Tip | Açıklama |
|---|---|
| string | Mesajla ilgili tüm detaylar string içerisinde dönmektedir. Servis cevabı içerisindeki parametreler aşağıda açıklanmıştır. |
Mesajla ilgili servisten gönderilen değerler aşağıdaki gibidir:
| Ad | Açıklama |
|---|---|
| ServisHata | Servisten gönderilen hata kodlarıdır. |
| Id | Mesajın ID değeridir. |
| PaketId | Raporu sorgulanan mesajın paket ID değeridir. |
| GonderimTarih | Mesajın gönderildiği tarih bilgisidir. |
| UlasimTarih | Mesajın kişinin telefonuna iletildiği tarih bilgisidir. |
| Origin | Mesajın gönderildiği başlık bilgisidir. |
| Alici | Mesajın gönderildiği telefon numarasıdır. |
| MesajUzunluğu | Gönderilen mesajın kaç mesaj uzunluğunda olduğunu gösterir. |
| GonderimDurum | Gönderilen mesajın durum kodunu gösterir. Durum
kodlarının
açıklamaları şu şekildedir: 0 = > Gönderilmek üzere bekleniyor. 1 = > İletildi. 2 = > Rapor bekleniyor. 3 = > Hatalı 4 = > Zaman aşımı 5 = > İptal edildi. |
| GonderimDurumAciklama | Gönderilen mesajın durum açıklamasıdır. |
| Icerik | Gönderilen mesaj metni bilgisidir. |
Json Response örneği aşağıdaki gibidir:
"[{"ServisHata":0, "Id":"XXXXXXXX", "PaketId":"2018072821535420459", "GonderimTarih":"202206101455" ,"UlasimTarih":"202206101455", "Origin":"ORNBASLIK", "Alici":"905XXXXXXXXX", "MesajUzunluğu":1, "GonderimDurum":2, "GonderimDurumAciklama":"SMS gonderilmek icin mesaj merkezine iletildi.(0)", "Icerik":"Ornek mesaj metni"}]"