Servisler
Başlarken
PanelKeşfet API
REX API
Ödeme Yönetimi
Tek kullanıcıya veya tüm takipçilere mesaj gönderimi
Tek kullanıcıya veya tüm takipçilere mesaj/mesajlar gönderimini sağlayan servistir. Servisi takip eden tüm kullanıcılara mesaj göndermek için type değeri 1 verilir ve address değeri gönderilmez ancak bu işlem eş zamansız çalışır. Kullanıcı servisi takip ettiğinde session (oturum) oluşur, servise doğru mesaj attığında session yenilenir. Kullanıcıya mesaj atabilmek için servisle kullanıcı arasında geçerli bir session olmalıdır. Takipçiye gönderilecek mesaj tipine göre servisin beklediği JSON formatı şekillenir. Gönderilebilecek mesaj tipleri ve formatları için bakınız
Format
Servis kullanıcı adı/şifresi Basic Authentication kullanılarak Header içerisinde gönderilir.İstek
POSThttps://tims.turkcell.com.tr/tes/rest/spi/sendmsgserv
| Özellik | Değer | Açıklama |
| *txnid | string | isteğe ait id değeri |
| *receiver | object | |
| *type | int | Mesaj gönderilecek kullanıcının adres türü. Alabileceği değerler: 0 -> Hash (karıştırılmış) adres 1 -> Servisi takip eden tüm adresler 2 -> MSISDN (açık numara) |
| *address | string | type ile belirtilen türdeki adres. type 0 ise address karıştırılmış formattadır, bipussu tarafından verilen değer girilir. type 1 ise address değeri istek içerisinde yer almamalıdır. type 2 ise address 905XXXXXXXXX formatında verilir. |
| *composition | object | |
| *list | list | Gönderilecek mesaj listesi. En az 1 tane eklenmelidir. |
| *type | int | Mesaj tipi. Alabileceği değerler: 0 – Metin 2 – Fotoğraf 3 – Ses 4 – Video 5 – Çıkartma 6 – Caps 7 – Konum 9 – Bitiş Çizgisi 10 – Kontak 13 – Şablon Medya Mesajı 14 – Doküman |
| seçilen tipe bağlı olarak diğer parametreler eklenir | İçerik tipine bağlı olarak farklı parametreler bu alanda yer alır. Formatlar için içerik tipleri listesini inceleyin. | |
| expire | int | Mesajın kaç saniye sonra kaybolcağını belirten değerdir. Alabileceği değerler: 3,5,10,60 |
| ttl | int | Time to leave değeridir. Mesajın kaç saniye sonra geçerliliğini kaybedeceğini ve gönderimin iptal olacağını belirtir. |
Yanıt
| Özellik | Değer | Açıklama |
| *txnid | string | isteğe ait id değeri |
| *resultcode | string | Yanıt değeri. Başarılı işlemler için 0 dönülür. Hatalı işlemler için Hata Kodları kısmında belirtilen değer dönülür. |
| *list | list | Sonuç başarılı ise ve rapor alınabiliyor ise bu alan doludur. |
| *resultcode | int | Gönderim sonucu. Başarılı işlemler için 0 dönülür. Hatalı işlemler için Hata Kodları kısmında belirtilen değer dönülür. |
| *receiver | string | Gönderim yapılan alıcı. |
| *reportid | string | Kullanıcıya gönderilen mesajın idsi. |
| *numberofmessage | int | Kullanıcıya mesajlar top |
| *totalnumberofmessage | int | Kullanıcıya gönderilen mesaj sayısı. |
Örnek: Video gönderimi
İstek
{
"txnid": "156",
"receiver": {
"type": 2,
"address": "9053XXXXXXXX"
}
},
"composition": {
"list": [{
"type": 4,
"message": "https://timsac.turkcell.com.tr/scontent/p2p/04032016/10/Vedb8d12f22a3ac286622841e61203b2d09805a24c893c47548d98ef675e771295.mp4",
"size": 120,
"ratio": 1
}]
}
}
Başarılı Yanıt (Rapor Alamayan)
{
"txnid": "156",
"resultcode": 0
}
Başarılı Yanıt (Rapor Alabilen)
{
"txnid": "200",
"resultcode": 0,
"list": [{
"resultcode": 0,
"receiver": "905XXXXXXXXX",
"reportid": "34cvA-2542",
"numberofmessage": 1,
"totalnumberofmessage": 1
}]
}
Hatalı Yanıt
{
"txnid": "156",
"resultcode": 312
}
Örnek: Tüm takipçilere metin gönderimi
{
"txnid": "2200",
"receiver": {
"type": 1
},
"composition": {
"list": [{
"type": 0,
"message": "test"
}]
}
}
{
"txnid": "2200",
"resultcode": 0
}
Tüm takipçilere gönderim eş zamansız olduğundan dolayı isteğe yanıt olarak reportid’ler gönderilmez. reportid’ler geri bildirim url’i+/report adresine gönderilir. Bu reportid’lere ait iletildi/okundu rapoları servisin geri bildirim url’inden dinlenir. Detaylı bilgi için rapor alma bölümünü inceleyiniz.
Doğrulamalar
- txnid değeri null, boş ya da 40 karakterden fazla olamaz. [1000]
- receiver alanı null olamaz, boş olamaz. [1008]
- type değeri null olamaz, boş olamaz. 0, 1, 2 harici bir değer olamaz. [1008]
- address değeri:
- type değeri 0 (şifrelenmiş numara) iken null ya da boş olmamalıdır. [1008]
- type değeri 1 (bütün takipçilere) iken istekte yer almamalıdır. [1008]
- type değeri 2 (şifrelenmemiş numara) iken null ya da boş olmamalıdır. En az 3 en fazla 15 karakter uzunluğunda ve MSISDN (E164 formatı) formatında olmalıdır. [1008]
- expire değeri null olabilir. Fakat 3, 5, 10, 60 harici bir değer olamaz. [1001].
- composition alanı boş olamaz, içerisindeki list alanı null olamaz, boş olamaz. Listenin eleman sayısı 5’den fazla olamaz. [1002]
- listin içerisindeki her eleman için içerik tipi doğrulamaları gerçekleştirilir. Her içeriğin kendine özgü formatı ve doğrulamaları vardır, bunlar kontrol edilmelidir.
Hata Kodları
| resultcode |
Açıklama |
| 1000 | invalid txnid |
| 1001 | invalid expire value |
| 1002 | invalid content |
| 1008 | invalid receiver address |
