API Dokümanları
SMS REQUEST GÖNDERİM METOTLARI
1. /Request /Otp /SendSms
Bu fonksiyon mesajın tek bir kişiye hızlı olarak gönderilmesini sağlar. Parametrelerin, URL adresinde servise gönderilmesi gerekir.
https://restapi.ttmesaj.com/Request/Otp/SendSms
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| TokenUsername | string | API erişimi için kullanılan Kullanıcı Adı bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| TokenPassword | string | API erişimi için kullanılan Şifre bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| PhoneNumber | string | 905XXXXXXXXX | 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. | |
| Text | string | Gönderilmek istenen mesaj metni bilgisidir. Zorunlu bir alandır. | ||
| Username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| Password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| Origin | string | Mesaj başlık bilgisidir. Zorunlu bir alandır. | ||
Request örneği aşağıdaki gibidir:
https://restapi.ttmesaj.com/Request/Otp/SendSms?
TokenUsername=xxxx
&TokenPassword=xxxx
&PhoneNumber=905XXXXXXXXX
&Text=Ornek mesaj metni
&Username=xxxx
&Password=xxxx
&Origin=ORNBASLIK
Response örneği aşağıdaki gibidir, eğer gönderim başarılı ise mesaj ID değeri yıldız (*) karakterinden sonra gönderilmektedir:
*OK*2018072821535420459
2. /Request /SendSingle /SendSms
Tek bir mesaj metninin bir kişiye gönderilmesini sağlar. Parametrelerin, URL adresinde servise gönderilmesi gerekir.
https://restapi.ttmesaj.com/Request/SendSingle/SendSms
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| TokenUsername | string | API erişimi için kullanılan Kullanıcı Adı bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| TokenPassword | string | API erişimi için kullanılan Şifre bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| PhoneNumber | string | 905XXXXXXXXX | 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. | |
| Text | string | Gönderilmek istenen mesaj metni bilgisidir. Zorunlu bir alandır. | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| origin | string | Mesaj başlık bilgisidir. Zorunlu bir alandır. | ||
| sd | string | yyyyMMddHHmm | Mesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır. | |
| ed | 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. | |
| isNotification | boolean | İYS kapsamında olan kullanıcılar için Gönderim Tipi bilgisidir. Gönderim Tipi TİCARİ ise "Kampanya", aksi halde “Bildirim”dir. Eğer parametre değeri true ise, Gönderim Tipi “Bildirim”dir ve mesaj İYS kontrolüne girmez. Eğer parametre değeri false ise Gönderim Tipi “Kampanya”dır ve mesaj İYS kontrolüne girer. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| recipentType | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerin Alıcı Tipini belirler. Parametre değeri BIREYSEL veya TACIR olmalıdır. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| brandCode | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerde firmanın SMS gönderimi yapmak istediği markasına ait brandCode(marka İYS numarası) bilgisidir. Hangi markaya ait SMS gönderimi yapılıyorsa, ilgili markanın brandCode değeri yazılmalıdır. İYS kapsamında olmayan kullanıcılar için boş(“ ”) olarak gönderilebilir. | ||
Request örneği aşağıdaki gibidir:
https://restapi.ttmesaj.com/Request/SendSingle/SendSms?
TokenUsername=xxxx
&TokenPassword=xxxx
&PhoneNumber=905XXXXXXXXX
&Text=Ornek mesaj metni
&username=xxxx
&password=xxxx
&origin=ORNBASLIK
&sd=0
&ed=202206101455
&isNotification=false
&recipentType=BIREYSEL
&brandCode=XXXXXX
Response örneği aşağıdaki gibidir, eğer gönderim başarılı ise mesaj ID değeri yıldız (*) karakterinden sonra gönderilmektedir:
*OK*2018072821535420459
3. /Request /SendSingle /SendOneToN
Bu fonksiyon tek bir mesaj metninin bir ya da birden fazla kişiye aşağıda belirtilen XML formatında tek bir pakette gönderimi için kullanılmaktadır.
https://restapi.ttmesaj.com/Request/SendSingle/SendOneToN
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| TokenUsername | string | API erişimi için kullanılan Kullanıcı Adı bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| TokenPassword | string | API erişimi için kullanılan Şifre bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| XML | string | XML formatı aşağıda açıklanmıştır. Zorunlu bir alandır. | ||
| isNotification | boolean | İYS kapsamında olan kullanıcılar için Gönderim Tipi bilgisidir. Gönderim Tipi TİCARİ ise "Kampanya", aksi halde “Bildirim”dir. Eğer parametre değeri true ise, Gönderim Tipi “Bildirim”dir ve mesaj İYS kontrolüne girmez. Eğer parametre değeri false ise Gönderim Tipi “Kampanya”dır ve mesaj İYS kontrolüne girer. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| recipentType | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerin Alıcı Tipini belirler. Parametre değeri BIREYSEL veya TACIR olmalıdır. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| brandCode | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerde firmanın SMS gönderimi yapmak istediği markasına ait brandCode(marka İYS numarası) bilgisidir. Hangi markaya ait SMS gönderimi yapılıyorsa, ilgili markanın brandCode değeri yazılmalıdır. İYS kapsamında olmayan kullanıcılar için boş(“ ”) olarak gönderilebilir. | ||
Gönderilmesi gereken XML parametresinin formatı aşağıdaki gibidir:
Request örneği aşağıdaki gibidir:
https://restapi.ttmesaj.com/Request/SendSingle/SendOneToN?
TokenUsername=xxxx
&TokenPassword=xxxx
&username=xxxx
&password=xxxx
&XML=Yukarıda açıklanan XML formatı bu alana yazılmalıdır.
&isNotification=false
&recipentType=BIREYSEL
&brandCode=XXXXXX
Response örneği aşağıdaki gibidir, eğer gönderim başarılı ise mesaj ID değeri yıldız (*) karakterinden sonra gönderilmektedir:
*OK*2018072821535420459
4. /Request /SendSingle /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/Request/SendSingle/SendNToN
Metoda gönderilmesi gereken parametreler ve açıklamaları aşağıdaki şekildedir:
| Parametre Adı | Tip | Format | Açıklama | |
|---|---|---|---|---|
| TokenUsername | string | API erişimi için kullanılan Kullanıcı Adı bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| TokenPassword | string | API erişimi için kullanılan Şifre bilgisidir. Zorunlu bir alandır. Kullanıcı adı ve şifre bilgisini 444 21 66 numaralı hattı arayarak alabilirsiniz. | ||
| username | string | Kullanıcı Adı bilgisidir. Zorunlu bir alandır. | ||
| password | string | Şifre bilgisidir. Zorunlu bir alandır. | ||
| xmData | string | Formatı aşağıda açıklanmıştır. Zorunlu bir alandır. | ||
| origin | string | Mesaj başlık bilgisidir. Zorunlu bir alandır. | ||
| sd | string | yyyyMMddHHmm | Mesaj gönderim zamanı. Hemen gönderilmek istenen mesajlar için boş(“ ”) veya sıfır(0) olmalıdır. | |
| ed | 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. | |
| isNotification | boolean | İYS kapsamında olan kullanıcılar için Gönderim Tipi bilgisidir. Gönderim Tipi TİCARİ ise "Kampanya", aksi halde “Bildirim”dir. Eğer parametre değeri true ise, Gönderim Tipi “Bildirim”dir ve mesaj İYS kontrolüne girmez. Eğer parametre değeri false ise Gönderim Tipi “Kampanya”dır ve mesaj İYS kontrolüne girer. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| recipentType | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerin Alıcı Tipini belirler. Parametre değeri BIREYSEL veya TACIR olmalıdır. İYS kapsamında olmayan kullanıcılar boş(“ ”) olarak gönderebilir. | ||
| brandCode | string | İYS kapsamında olan kullanıcılar için Gönderim Tipi Kampanya olan iletilerde firmanın SMS gönderimi yapmak istediği markasına ait brandCode(marka İYS numarası) bilgisidir. Hangi markaya ait SMS gönderimi yapılıyorsa, ilgili markanın brandCode değeri yazılmalıdır. İYS kapsamında olmayan kullanıcılar için boş(“ ”) olarak gönderilebilir. | ||
Gönderilmesi gereken xmData parametresinin formatı aşağıdaki gibidir:
Request örneği aşağıdaki gibidir:
https://restapi.ttmesaj.com/Request/SendSingle/SendNToN?
TokenUsername=xxxx
&TokenPassword=xxxx
&username=xxxx
&password=xxxx
&xmData=Yukarıda açıklanan XML formatı bu alana yazılmalıdır.
&origin=ORNBASLIK
&sd=0
&ed=202206101455
&isNotification=false
&recipentType=BIREYSEL
&brandCode=XXXXXX
Response örneği aşağıdaki gibidir, eğer gönderim başarılı ise mesaj ID değeri yıldız (*) karakterinden sonra gönderilmektedir:
*OK*2018072821535420459