API Dokümanları
OTP GÖNDERİM METOTLARI
1. /api /Otp /SendSms
Bu fonksiyon mesajın tek bir kişiye hızlı olarak gönderilmesini sağlar.
https://restapi.ttmesaj.com/api/Otp/SendSms
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. | ||
| number | string | Gönderim yapmak istenen numara. Yurtdışı numaraları 00 ile başlamalı ve en az 12 karakter olmalıdır. Türkiye için 90 ile (0090 kabul edilmez) başlamalı ve minimum 12 hane olmalıdır. Zorunlu bir alandır. | ||
| origin | string | Mesaj başlık bilgisidir. Zorunlu bir alandır. | ||
| messageText | string | Gönderilmek istenen İngilizce karakterli mesaj metnidir. En fazla 160 karakter olabilir ve içerisinde Türkçe karakter(ğ, ü, i, ö, ç vb.) olmamalıdır. | ||
| sendDate | string | yyyyMMddHHmm | Mesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır. | |
| endDate | string | yyyyMMddHHmm | Mesajın son teslim zamanı. Herhangi bir zaman belirtilmek istenmediğinde default olarak 72 saat sonrası olarak belirlenir. Zaman belirtilmek istenmediğinde boş(“ ”) veya sıfır(0) olmalıdır. | |
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx"
"number": "905XXXXXXXXX",
"origin": "ORNBASLIK",
"messageText": "Ornek mesaj metni ",
"sendDate": "0",
"endDate": " 202401101500"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama | |
|---|---|---|---|
| sonuc | string | Sonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir. | |
| kontor | string | Kalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir. | |
| message | string | Mesaj gönderimine ait durum bilgisinin açıklaması bu parametre içerisinde gönderilmektedir. | |
Json Response örneği aşağıdaki gibidir:
{
"sonuc": "*OK*2018072821535420459",
"kontor": "100",
"message": "*OK*"
}
2. /api /Otp /SendSmsSimChange
Bu fonksiyon mesajın tek bir kişiye sim kart değişikliği kontrol edilerek ve hızlı olarak gönderilmesini sağlar.
https://restapi.ttmesaj.com/api/Otp/SendSmsSimChange
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. | ||
| number | string | Gönderim yapmak istenen numara. Yurtdışı numaraları 00 ile başlamalı ve en az 12 karakter olmalıdır. Türkiye için 90 ile (0090 kabul edilmez) başlamalı ve minimum 12 hane olmalıdır. Zorunlu bir alandır. | ||
| origin | string | Mesaj başlık bilgisidir. Zorunlu bir alandır. | ||
| messageText | string | Gönderilmek istenen İngilizce karakterli mesaj metnidir. En fazla 160 karakter olabilir ve içerisinde Türkçe karakter(ğ, ü, i, ö, ç vb.) olmamalıdır. | ||
| isSimChangeControl | boolean | Türk Telekom abonesi ve firmanın hesabında tanımlı süre içerisinde kart değişikliği yapmamış abonelere SMS gönderimi yapmak için kullanılmaktadır. Eğer “true” olarak gönderilirse, SMS gönderimi yapılacak numaranın Türk Telekom abonesi olup olmadığı kontrol edilir. Numara Türk Telekom abonesi ise, sim kart değişikliği yapıp yapmadığı kontrol edilir. Değişiklik yapıldıysa hata mesajı verilir, yapılmadıysa SMS gönderilir. Eğer “false” olarak gönderilirse, SMS gönderimi yapılacak numaranın Türk Telekom abonesi olup olmadığı kontrol edilir. Numara Türk Telekom abonesi değil ise SMS gönderilir. Türk Telekom abonesi ise sim kart değişikliği yapıp yapmadığı kontrol edilir. Değişiklik yapıldıysa hata mesajı verilir, yapılmadıysa SMS gönderilir. | ||
| simChangeCheckDate | string | ddMMyyyyHHmmss | Sim kart değişikliğinin kontrol edileceği tarih bilgisi. Eğer firmanın hesabında tanımlı süre içerisinde sim kart değişikliği yapılmışsa, parametrede gönderilen tarih ile sim kart değişiklik tarihi kontrol edilir. Eğer parametrede gönderilen tarih sim kart değişiklik tarihinden önce ise SMS gönderilmez. Eğer parametrede gönderilen tarih sim kart değişiklik tarihinden sonra ise SMS gönderilir. | |
| sendDate | string | yyyyMMddHHmm | Mesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır. | |
| endDate | string | yyyyMMddHHmm | Mesajın son teslim zamanı. Herhangi bir zaman belirtilmek istenmediğinde default olarak 72 saat sonrası olarak belirlenir. Zaman belirtilmek istenmediğinde boş(“ ”) veya sıfır(0) olmalıdır. | |
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx"
"number": "905XXXXXXXXX",
"origin": "ORNBASLIK",
"messageText": "Ornek mesaj metni ",
"isSimChangeControl": true,
"simChangeCheckDate": "24122009175500",
"sendDate": "0",
"endDate": " 202401101500"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama | |
|---|---|---|---|
| sonuc | string | Sonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir. | |
| kontor | string | Kalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir. | |
| message | string | Mesaj gönderimine ait durum bilgisinin açıklaması bu parametre içerisinde gönderilmektedir. | |
Json Response örneği aşağıdaki gibidir:
{
"sonuc": "*OK*2018072821535420459",
"kontor": null,
"message": "Sunucuya başarıyla teslim edildi."
}