TTMESAJ

TCKN GÖNDERİM METOTLARI

1. /api /TcknSms /SendSingle

Tek bir mesaj metnini bir veya birden fazla kişiye tek bir paket içerisinde gönderilmesini sağlar. SMS birden fazla kişiye gönderilmek istendiğinde numaraların arasına virgül(,) karakteri eklenmelidir. 

https://restapi.ttmesaj.com/api/TcknSms/SendSingle

Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:

Parametre Adı Tip Format Açıklama
HeaderAuthorizationBearer access_token bilgisi
usernamestringKullanıcı Adı bilgisidir. Zorunlu bir alandır.
passwordstringŞifre bilgisidir. Zorunlu bir alandır.
tcknstring1XXXXXXXXX0Gönderim yapmak istenen T.C. kimlik numaraları. 11 karakter olarak gönderilmelidir. Zorunlu bir alandır.
messagestringGönderilmek istenen mesaj metni bilgisidir. Zorunlu bir alandır.
originstringMesaj başlık bilgisidir. Zorunlu bir alandır.
sdstringyyyyMMddHHmmMesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır.
edstringyyyyMMddHHmmMesajı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",
  "tckn": "1XXXXXXXXX0",
  "message": "Örnek mesaj metni",
  "origin": "ORNBASLIK",
  "sd": "0",
  "ed": "202206101455"
}

Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:

Parametre Adı Tip Açıklama
sonucstringSonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir.
kontorstringKalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir.
messagestringMesaj 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 /TcknSms /SendOneToN

Bu fonksiyon tek bir mesaj metnini bir ya da birden fazla kişiye aşağıda belirtilen XML formatında tek bir pakette gönderim için kullanılmaktadır.

https://restapi.ttmesaj.com/api/TcknSms/SendOneToN

Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:

Parametre Adı Tip Format Açıklama
HeaderAuthorizationBearer access_token bilgisi
userNamestringKullanıcı Adı bilgisidir. Zorunlu bir alandır.
passwordstringŞifre bilgisidir. Zorunlu bir alandır.
xmlstringXML formatı aşağıda açıklanmıştır. Zorunlu bir alandır.

Gönderilmesi gereken XML parametresinin formatı aşağıdaki gibidir:


<SINGLE_SMS>
    <ORIGIN>Mesaj başlık bilgisi</ORIGIN>

    <SEND_DATE>
        Mesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş("") 
        veya sıfır(0) olmalıdır. İleri tarihli gönderim yapmak istiyorsanız 
        sonlanma zamanı olarak minimum 1 saat sonrası olarak belirlenmeli 
        yyyyMMddHHmm formatında olmalıdır.
    </SEND_DATE>

    <END_DATE>
        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.
    </END_DATE>

    <MESSAGE>Gönderilmek istenen mesaj metni</MESSAGE>

    <SMS>
        <TCKN>1XXXXXXXXX0</TCKN>
    </SMS>

    <SMS>
        <TCKN>1XXXXXXXXX0</TCKN>
    </SMS>

</SINGLE_SMS>

Json Request örneği aşağıdaki gibidir:

{
  "username": "xxxx",
  "password": "xxxx",
  "xml": "Yukarıda açıklanan XML formatı bu alana yazılmalıdır."
}

Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:

Parametre Adı Tip Açıklama
sonucstringSonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir.
kontorstringKalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir.
messagestringMesaj 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*"
}

3. /api /TcknSms /SendNToN

Bu fonksiyon farklı mesaj metinlerini birden fazla kişiye aşağıdaki XML formatında tek bir pakette gönderim için kullanılmaktadır.

https://restapi.ttmesaj.com/api/TcknSms/SendNToN

Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:

Parametre Adı Tip Format Açıklama
HeaderAuthorizationBearer access_token bilgisi
usernamestringKullanıcı Adı bilgisidir. Zorunlu bir alandır.
passwordstringŞifre bilgisidir. Zorunlu bir alandır.
xmDatastringFormatı aşağıda açıklanmıştır. Zorunlu bir alandır.
originstringMesaj başlık bilgisidir. Zorunlu bir alandır.
sdstringyyyyMMddHHmmMesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır.
edstringyyyyMMddHHmmMesajı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.

Gönderilmesi gereken xmData parametresinin formatı aşağıdaki gibidir:

<SMS>
                                                
      <kisi>
            <mesaj>Gönderilmek istenen mesaj metni</mesaj>
            <tckn>1XXXXXXXXX0</tckn>
      </kisi>
                                                
      <kisi>
            <mesaj>Gönderilmek istenen mesaj metni</mesaj>
            <tckn>1XXXXXXXXX0</tckn>
      </kisi>
                                                
</SMS>
                                                

Json Request örneği aşağıdaki gibidir:

{
  "username": "xxxx",
  "password": "xxxx",
  "xmData": "Yukarıda açıklanan XML formatı bu alana yazılmalıdır.",
  "origin": "ORNBASLIK",
  "sd": "0",
  "ed": "202206101455"
}

Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:

Parametre Adı Tip Açıklama
sonucstringSonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir.
kontorstringKalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir.
messagestringMesaj 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*"
}

4. /api /TcknSms /cancelSMS

Bu fonksiyon mesajın iptal edilmesini sağlar.

https://restapi.ttmesaj.com/api/TcknSms/cancelSMS

Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:

Parametre Adı Tip Format Açıklama
HeaderAuthorizationBearer access_token bilgisi
userNamestringKullanıcı Adı bilgisidir. Zorunlu bir alandır.
passwordstringŞifre bilgisidir. Zorunlu bir alandır.
packageIdstringSMS 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:

Parametre Adı Tip Açıklama
sonucstringSonuç bilgisi ve eğer gönderim başarılı ise mesaj ID değeri bu parametre içerisinde gönderilmektedir.
kontorstringKalan kontör bilgisidir. Eğer hesap faturalı ise parametre değeri “Hesabiniz faturalidir.” şeklinde gönderilir.
messagestringMesaj 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*"
}