API Dokümanları
SMS GÖNDERİM METOTLARI
1. /api /SendSms /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/SendSms/SendSingle
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. | ||
| numbers | string | 905XXXXXXXXX | Gönderim yapmak istenen numaralar. Yurtdışı numaraları 00 ile başlamalı ve en az 12 karakter olmalıdır. Zorunlu bir alandır. | |
| message | string | Gönderilmek istenen mesaj metni 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. | ||
Json Request örneği aşağıdaki gibidir:
{
"username": "xxxx",
"password": "xxxx",
"numbers": "905XXXXXXXXX",
"message": "Örnek mesaj metni",
"origin": "ORNBASLIK",
"sd": "0",
"ed": "202206101455",
"isNotification": false,
"recipentType": "BIREYSEL",
"brandCode": "XXXXXX"
}
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 /SendSms /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/SendSms/SendOneToN
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. | ||
| 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:
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.",
"isNotification": false,
"recipentType": "BIREYSEL",
"brandCode": "XXXXXX"
}
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*"
}
3. /api /SendSms /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/SendSms/SendNToN
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. | ||
| 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:
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",
"isNotification": false,
"recipentType": "BIREYSEL",
"brandCode": "XXXXXX"
}
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*"
}
4. /api /SendSms /cancelSMS
Bu fonksiyon mesajın iptal edilmesini sağlar.
https://restapi.ttmesaj.com/api/SendSms/cancelSMS
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:
| 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*"
}