API Dokümanları
İYS ENTEGRASYONU METOTLARI
1. /api /Iys /SendRecipient
İleti Yönetim Sistemleri'ne Onay/Ret durumu aktarılmasını sağlayan metotdur.
https://restapi.ttmesaj.com/api/Iys/SendRecipient
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. Zorunludur. | |
| password | string | Şifre bilgisidir. Zorunludur. | |
| permissionType | string | ARAMA / MESAJ / EPOSTA | İzin tipi bilgisidir. |
| brandCode | string | İYS marka kodu bilgisidir. | |
| permissionStatus | string | ONAY / RET | İzin durumu bilgisidir. |
| permissionSource | int | 1-13 | İzin kaynağı bilgisidir. |
| isCheckBlackList | string | 0 / 1 | Kara liste kontrolü yapılacağını belirtir. |
| recipient | string | Telefon numarası bilgisidir. | |
| receiveType | string | BIREYSEL / TACIR | Alıcı tipi bilgisidir. |
| consentDate | string | dd.MM.yyyy HH:mm | İzin tarihi bilgisidir. |
Json Request örneği aşağıdaki gibidir:
{
"userName": "xxxx",
"password": "xxxx",
"permissionType": "MESAJ",
"brandCode": "XXXXXX",
"permissionStatus": "ONAY",
"permissionSource": 1,
"isCheckBlackList": "0",
"iysDatas": [
{
"recipient": "905XXXXXXXXX",
"receiveType": "BIREYSEL",
"consentDate": "14.11.2024 15:30"
}
]
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama |
|---|---|---|
| responseCode | string | İşlem sonucu kodu. |
| responseDesc | string | İşlem sonucu açıklaması. |
| packageId | string | Gönderime ait paket numarasıdır. |
Json Response örneği aşağıdaki gibidir:
{
"responseCode": "0",
"responseDesc": "Sunucuya başarıyla teslim edildi.",
"packageId": "70f54d70-b133-4160-b79a-XXXXXXXXXXXX"
}
2. /api /Iys /Report
Belirli paket ID değerine göre İleti Yönetim Sistemleri üzerinden raporlama yapılmasını sağlar.
https://restapi.ttmesaj.com/api/Iys/Report
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. | |
| password | string | Şifre bilgisidir. | |
| permissionType | string | ARAMA / MESAJ / EPOSTA | İzin tipi bilgisidir. |
| packageId | string | Gönderim sonucunda dönen paket numarasıdır. |
Json Request örneği aşağıdaki gibidir:
{
"userName": "xxxx",
"password": "xxxx",
"permissionType": "MESAJ",
"packageId": "70f54d70-b133-4160-b79a-XXXXXXXXXXXX"
}
Metottan dönen cevap parametreleri ve açıklamaları aşağıdaki gibidir:
| Parametre Adı | Tip | Açıklama |
|---|---|---|
| responseCode | string | İşlem sonucu kodu. |
| responseDesc | string | İşlem sonucu açıklaması. |
| brandCode | string | Marka kodu. |
| permissionSourceId | string | İzin kaynağı kodu. |
| recipient | string | Alıcı bilgisi. |
| consentDate | string | İzin tarihi. |
| processStatus | string | İşlem durumu. |
| processDesc | string | İşlem açıklaması. |
| message | string | İYS tarafından dönen mesaj. |
Json Response örneği aşağıdaki gibidir:
{
"responseCode": "1",
"responseDesc": "",
"datasList": [
{
"brandCode": "XXXXXX",
"permissionSourceId": "1",
"recipient": "+905XXXXXXXXX",
"consentDate": "14.11.2024 15:30",
"processStatus": "0",
"processDesc": "Başarılı",
"message": ""
}
]
}
Genel Tanımlar
| Source Id | Value | ValueDesc |
|---|---|---|
| 1 | HS_2015 | 1 Mayıs 2015 tarihi öncesinde onaylı olarak kaydedilmiştir. |
| 2 | HS_KARAR | İzin durumu, hizmet sağlayıcının kendi isteğiyle belirlenmiştir. |
| 3 | HS_FIZIKSEL_ORTAM | İzin, hizmet sağlayıcı tarafından fiziksel ortamda alınmıştır. |
| 4 | HS_ISLAK_IMZA | İzin, alıcının bir formu veya anketi imzalaması üzerine alınmıştır. |
| 5 | HS_ETKINLIK | İzin, hizmet sağlayıcının düzenlediği bir etkinlikte alınmıştır. |
| 6 | HS_ATM | İzin, hizmet sağlayıcıya ait yerleşik ATM cihazıyla alınmıştır. |
| 7 | HS_EORTAM | İzin, hizmet sağlayıcıya ait bir elektronik ortamda alınmıştır. |
| 8 | HS_WEB | İzin, hizmet sağlayıcının web sitesi üzerinde yapılan bir işlemle alınmıştır. |
| 9 | HS_MOBIL | İzin, hizmet sağlayıcıya ait mobil uygulama üzerinden alınmıştır. |
| 10 | HS_MESAJ | İzin, hizmet sağlayıcıya ait kısa mesaj numarası üzerinden alınmıştır. |
| 11 | HS_EPOSTA | İzin, hizmet sağlayıcıya ait e-posta vasıtasıyla alınmıştır. |
| 12 | HS_CAGRI_MERKEZI | İzin, hizmet sağlayıcıya bağlı bir çağrı merkezinde sesle veya numara tuşlamayla. |
| 13 | HS_SOSYAL_MEDYA | İzin, hizmet sağlayıcıya ait sosyal medya aracı üzerinden alınmıştır. |
| Kod | Açıklama |
|---|---|
| -2 | Sistemde hata oluştu. |
| -1 | Sistem hatası. |
| 0 | Sunucuya başarıyla teslim edildi. |
| 1 | Bu işlemi gerçekleştirmek için gerekli Ip yetkisine sahip değilsiniz. |
| 2 | Kullanıcı adı/şifre boş bırakılamaz. |
| 3 | Kullanıcı adınız/şifreniz veya Brand Kodu eksik ya da hatalıdır. |
| 4 | Mesaj metnini boş bırakılamaz. |
| 5 | Alıcı Listesi Boş Olamaz. |
| 6 | BrandCode Hatalı. |
| 7 | Alıcı Listesi (IysDatas) 1000 Adet'den Fazla Olamaz. |
| 8 | İzin Durumu (PermissionStatus) ONAY veya RET Olarak Yazılmalıdır. |
| 9 | İzin Kaynağı (PermissionSource) Hatalı. |
| 10 | Kara Liste Kontrolü (isCheckBlackList) için 1 veya 0 Olarak Gönderilmelidir. |
| 11 | Alıcı Tipi (ReceiveType) Hatalı. BIREYSEL veya TACIR Olmalıdır. |
| 12 | İzin Türü (permissionType) ARAMA, MESAJ veya EPOSTA Olmalıdır. |
| 13 | Alıcı Listesinde hatalı Veri Tespit Edildi. |
| Değer | Açıklama |
|---|---|
| ARAMA | Arama izni |
| MESAJ | SMS izni |
| EPOSTA | E-posta izni |