API erişiminde güvenlik için Basic Authentication yöntemi kullanılmaktadır. İstekler için Basic Authentication bilgisinin header da gönderilmesi zorunludur.
Kimlik bilgilerini nasıl oluşturuyoruz
1. Kullanıcının kullanıcı adı ve şifresi iki nokta üst üste ile birleştirilir.
2. Ortaya çıkan dize base64 olarak kodlanır.
Örnek
Yani kullanıcı adınız ve şifreniz smsuser ve p4r0la ise, kombinasyon smsuser:p4r0la dır ve base64 kodlandığında, bu c21zdXNlcjpwNHIwbGE= olur. Bu nedenle, bu kullanıcı tarafından yapılan istekler aşağıdaki başlıkla gönderilir:
Request
Response
Request
Response
number | Kısa mesajı göndermek istediğiniz numaranın belirttiği alandır. (Zorunlu) | ||||||
sender | Başlık adı. Kısa mesajlarınızı alan kişilere gözükecek gönderen ismidir. (Zorunlu) | ||||||
content | Kısa mesaj içeriği. (Zorunlu) | ||||||
encoding | Mesajın kodlanma biçimidir. 3 değer alabilir.(Opsiyonel) Varsayılan değer Default
| ||||||
validity | Mesajın geçerlilik süresi. Minimum değer 3, Maksimum değer 6 dır. (Opsiyonel) Varsayılan değer 6 | ||||||
commercial | Ticari gönderimlerde true değeri girilmelidir. Ticari operatör tarafında IYS kontrolünden geçmektedir. Kullancı profilinde IYS Kodu ve Marka Kodu tanımlı olmalıdır. | ||||||
customID | Kullanıcı kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre. (Opsiyonel) Max 100 karakterdir. Harf, rakam, tire ' - ' ve nokta ' . ' değerlerini alabilir | ||||||
pushSettings | İlgili sms in raporunu push olarak göndermesini sağlar. (Opsiyonel) PushSettings den gelen data formatı için bakınız
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/create-otp |
Request
{
"number": "String",
"sender": "String",
"content": "String",
"encoding": 0,
"validity": 0,
"commercial":false,
"customID": "String",
"pushSettings": {
"url": "String"
}
}
Response
{
"data": {
"pkgID": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
type | Sms tipini belirtir (Sabit : 1) | ||||||
sendingType | Gönderim tipini belirtir (Sabit : 0) | ||||||
number | Kısa mesajı göndermek istediğiniz numaranın belirttiği alandır. (Zorunlu) | ||||||
sender | Başlık adı. Kısa mesajlarınızı alan kişilere gözükecek gönderen ismidir. (Zorunlu) | ||||||
title | Paket tanımlayıcı başlık. Minimum 5 maksimum 50 karakter olmalıdır (Zorunlu) | ||||||
content | Kısa mesaj içeriği. (Zorunlu) | ||||||
encoding | Mesajın kodlanma biçimidir. 3 değer alabilir.(Opsiyonel) Varsayılan değer Default
| ||||||
validity | Mesajın geçerlilik süresi. Minimum değer 60, Maksimum değer 1440 dır. (Opsiyonel) Varsayılan değer 1440 | ||||||
sendingDate | İleri tarihli SMS gönderilmek isteniyorsa kullanılır. Format "yyyy-MM-dd HH:mm" | ||||||
commercial | Ticari gönderimlerde true değeri girilmelidir. Ticari operatör tarafında IYS kontrolünden geçmektedir. Kullancı profilinde IYS Kodu ve Marka Kodu tanımlı olmalıdır. | ||||||
skipAhsQuery | Sms AHS sorgusuna gönderilmek istenmiyorsa true değeri girilmelidir. | ||||||
recipientType | AHS sorgu tipini belirler. Default 0 dır.
| ||||||
customID | Kullanıcı kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre. (Opsiyonel) Max 100 karakterdir. Harf, rakam, tire ' - ' ve nokta ' . ' değerlerini alabilir | ||||||
pushSettings | İlgili sms in raporunu push olarak göndermesini sağlar. (Opsiyonel) PushSettings den gelen data formatı için bakınız
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/create |
Request
{
"type": 1,
"sendingType": 0,
"title": "String",
"content": "String",
"number": "String",
"encoding": 0,
"sender": "String",
"sendingDate": "String",
"validity": 60,
"commercial": false,
"skipAhsQuery": true,
"recipientType": 0,
"customID": "String",
"pushSettings": {
"url": "String"
}
}
Response
{
"data": {
"pkgID": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$request = new SendSingleSms();
$request->title = "Title";
$request->content = "Single sms gönderim testi";
$request->number = 905006662211;
$request->encoding = 0;
$request->sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//$request->customID = "mesajId100";
//Ticari gönderimlerde true değeri girilmelidir.
//$request->commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//$request->skipAhsQuery = true;
//İleri tarihli gönderim için
//$request->sendingDate = "2021-01-10 13:00";
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//$request->pushUrl = "https://webhook.site/8d7ed0f7"
$response = $smsApi->sendSingleSms($request);
if($response->err == null){
echo "MessageId: ".$response->pkgID."\n";
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
RequestSendSingleSms request = new RequestSendSingleSms();
request.setTitle("Title");
request.setContent("Single sms gönderim testi");
request.setNumber("905001112233");
request.setSender("Gönderen Başlığı");
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//request.customID = "mesajId100";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//request.setCommercial(true);
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//request.setSkipAhsQuery(true);
//İleri tarihli gönderimlerde kullanılır
//request.setSendingDate("2022-01-05 12:35");
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//request.setPushSettings(new PushSettings("https://webhook.site/8d7ed0f7"));
ResponseSendSingleSms response = messenger.sendSingleSms(request);
if(response.getErr() == null) {
System.out.println("PaketID : " + response.getPkgID());
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var singleSmsRequest = new SendSingleSms();
singleSmsRequest.Content = "Deneme Mesajı";
singleSmsRequest.Number = 905001234567;
singleSmsRequest.Sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//singleSmsRequest.CustomId = "mesajID101";
//Title boş gönderilirse otomatik olarak yyyy-MM-dd hh:mm:ss formatını alır
singleSmsRequest.Title = "Test Gönderimi";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//singleSmsRequest.Commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//singleSmsRequest.SkipAhsQuery = true;
//İleri tarihli gönderimlerde kullanılır Yıl - Ay - Gün - Saat - Dakika - Saniye
//singleSmsRequest.SendingDate = new DateTime(2021, 06, 11, 10, 00, 00);
var singleSmsResponse = messenger.SendSingleSms(singleSmsRequest);
if (singleSmsResponse.Err == null)
{
Console.WriteLine("Paket Id : " + singleSmsResponse.PackageId);
}
else
{
Console.WriteLine(
"Durum Statu : " + singleSmsResponse.Err.Status + "\n" +
"Durum Kodu : " + singleSmsResponse.Err.Code + "\n" +
"Durum Mesajı : " + singleSmsResponse.Err.Message
);
}
type | Sms tipini belirtir (Sabit : 1) | ||||||
sendingType | Gönderim tipini belirtir (Sabit : 1) | ||||||
numbers | Kısa mesajı göndermek istediğiniz numaraları belirttiğiniz alandır. (Zorunlu) | ||||||
sender | Başlık adı. Kısa mesajlarınızı alan kişilere gözükecek gönderen ismidir. (Zorunlu) | ||||||
title | Paket tanımlayıcı başlık. Minimum 5 maksimum 50 karakter olmalıdır (Zorunlu) | ||||||
content | Kısa mesaj içeriği. (Zorunlu) | ||||||
encoding | Mesajın kodlanma biçimidir. 3 değer alabilir.(Opsiyonel) Varsayılan değer Default
| ||||||
validity | Mesajın geçerlilik süresi. Minimum değer 60, Maksimum değer 1440 dır. (Opsiyonel) Varsayılan değer 1440 | ||||||
sendingDate | İleri tarihli SMS gönderilmek isteniyorsa kullanılır. Format "yyyy-MM-dd HH:mm" | ||||||
commercial | Ticari gönderimlerde true değeri girilmelidir. Ticari operatör tarafında IYS kontrolünden geçmektedir. Kullancı profilinde IYS Kodu ve Marka Kodu tanımlı olmalıdır. | ||||||
skipAhsQuery | Sms AHS sorgusuna gönderilmek istenmiyorsa true değeri girilmelidir. | ||||||
recipientType | AHS sorgu tipini belirler. Default 0 dır.
| ||||||
customID | Kullanıcı kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre. (Opsiyonel) Max 100 karakterdir. Harf, rakam, tire ' - ' ve nokta ' . ' değerlerini alabilir | ||||||
pushSettings | İlgili sms in raporunu push olarak göndermesini sağlar. (Opsiyonel) PushSettings den gelen data formatı için bakınız
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/create |
Request
{
"type": 1,
"sendingType": 1,
"title": "String",
"content": "String",
"numbers": ["String"],
"encoding": 0,
"sender": "String",
"sendingDate": "String",
"validity": 60,
"commercial": false,
"skipAhsQuery": true,
"recipientType": 0,
"customID": "String",
"pushSettings": {
"url": "String"
}
}
Response
{
"data": {
"pkgID": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$request = new SendMultiSms();
$request->title = "Title";
$request->content = "Multi sms gönderim testi";
$request->numbers = [905006662211,905006660011];
$request->encoding = 0;
$request->sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//$request->customID = "mesajId101";
//Ticari gönderimlerde true değeri girilmelidir.
//$request->commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//$request->skipAhsQuery = true;
//İleri tarihli gönderim için
//$request->sendingDate = "2021-01-10 13:00";
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//$request->pushUrl = "https://webhook.site/8d7ed0f7"
$response = $smsApi->sendMultiSms($request);
if($response->err == null){
echo "MessageId: ".$response->pkgID."\n";
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
RequestSendMultiSms request = new RequestSendMultiSms();
request.setTitle("Title");
request.setContent("Multi sms gönderim testi");
request.setSender("Gönderen Başlığı");
request.getNumbers().add("905001112233");
request.getNumbers().add("905002223344");
//Kendi sistemindeki id ‘ler ile eþleþtirme yapabilmek için kullanýlan parametre
//request.customID = "mesajId100";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//request.setCommercial(true);
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//request.setSkipAhsQuery(true);
//İleri tarihli gönderimlerde kullanılır
//request.setSendingDate("2022-01-05 12:35");
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//request.setPushSettings(new PushSettings("https://webhook.site/8d7ed0f7"));
ResponseSendMultiSms response = messenger.sendMultiSms(request);
if(response.getErr() == null) {
System.out.println("PaketID : " + response.getPkgID());
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var multiSmsRequest = new SendMultiSms();
multiSmsRequest.Content = "Deneme Mesajı";
multiSmsRequest.Numbers = new List<long>() { 905001234567 };
multiSmsRequest.Sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//multiSmsRequest.CustomId = "mesajID102";
//Title boş gönderilirse otomatik olarak yyyy-MM-dd hh:mm:ss formatını alır
multiSmsRequest.Title = "Test Gönderimi";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//multiSmsRequest.Commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//multiSmsRequest.SkipAhsQuery = true;
//İleri tarihli gönderimlerde kullanılır Yıl - Ay - Gün - Saat - Dakika - Saniye
//multiSmsRequest.SendingDate = new DateTime(2021, 06, 11, 10, 00, 00);
var multiSmsResponse = messenger.SendMultiSms(multiSmsRequest);
if (multiSmsResponse.Err == null)
{
Console.WriteLine("Paket Id : " + multiSmsResponse.PackageId);
}
else
{
Console.WriteLine(
"Durum Statu : " + multiSmsResponse.Err.Status + "\n" +
"Durum Kodu : " + multiSmsResponse.Err.Code + "\n" +
"Durum Mesajı : " + multiSmsResponse.Err.Message
);
}
type | Sms tipini belirtir (Sabit : 1) | ||||||
sendingType | Gönderim tipini belirtir (Sabit : 2) | ||||||
numbers | Kısa mesajı göndermek istediğiniz numaraları ve her bir numaraya gidecek mesajı belirttiğiniz alandır.
| ||||||
sender | Başlık adı. Kısa mesajlarınızı alan kişilere gözükecek gönderen ismidir. (Zorunlu) | ||||||
title | Paket tanımlayıcı başlık. Minimum 5 maksimum 50 karakter olmalıdır (Zorunlu) | ||||||
encoding | Mesajın kodlanma biçimidir. 3 değer alabilir.(Opsiyonel) Varsayılan değer Default
| ||||||
validity | Mesajın geçerlilik süresi. Minimum değer 60, Maksimum değer 1440 dır. (Opsiyonel) Varsayılan değer 1440 | ||||||
sendingDate | İleri tarihli SMS gönderilmek isteniyorsa kullanılır. Format "yyyy-MM-dd HH:mm" | ||||||
commercial | Ticari gönderimlerde true değeri girilmelidir. Ticari operatör tarafında IYS kontrolünden geçmektedir. Kullancı profilinde IYS Kodu ve Marka Kodu tanımlı olmalıdır. | ||||||
skipAhsQuery | Sms AHS sorgusuna gönderilmek istenmiyorsa true değeri girilmelidir. | ||||||
recipientType | AHS sorgu tipini belirler. Default 0 dır.
| ||||||
customID | Kullanıcı kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre. (Opsiyonel) Max 100 karakterdir. Harf, rakam, tire ' - ' ve nokta ' . ' değerlerini alabilir | ||||||
pushSettings | İlgili sms in raporunu push olarak göndermesini sağlar. (Opsiyonel)
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/create |
Request
{
"type": 1,
"sendingType": 2,
"title": "String",
"content": "String",
"numbers": [
{
"nr": "String",
"msg": "String"
}
],
"encoding": 0,
"sender": "String",
"sendingDate": "String",
"validity": 60,
"commercial": false,
"skipAhsQuery": true,
"recipientType": 0,
"customID": "String",
"pushSettings": {
"url": "String"
}
}
Response
{
"data": {
"pkgID": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$request = new SendDynamicSms();
$request->title = "Title";
$request->numbers = [
new SmsItem(905006662211, "Sayın Ali Efe bu bir test mesajıdır"),
new SmsItem(905006660011, "Sayın Ayse Ak bu bir test mesajıdır")
];
$request->encoding = 0;
$request->sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//$request->customID = "mesajId101";
//Ticari gönderimlerde true değeri girilmelidir.
//$request->commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//$request->skipAhsQuery = true;
//İleri tarihli gönderim için
//$request->sendingDate = "2021-01-10 13:00";
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//$request->pushUrl = "https://webhook.site/8d7ed0f7"
$response = $smsApi->sendDynamicSms($request);
if($response->err == null){
echo "MessageId: ".$response->pkgID."\n";
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
RequestSendDynamicSms request = new RequestSendDynamicSms();
request.setSender("Gönderen Başlığı");
request.setTitle("Title");
request.getNumbers().add(new SmsItem("905001234567", "Sayın Ali Efe bu bir deneme mesajı"));
request.getNumbers().add(new SmsItem("905009992211", "Sayın Ayşe Ak bu bir deneme mesajı"));
//Kendi sistemindeki id 'ler ile eşleştirme yapabilmek için kullanılan parametre
//request.customID = "mesajId100";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//request.setCommercial(true);
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//request.setSkipAhsQuery(true);
//İleri tarihli gönderimlerde kullanılır
//request.setSendingDate("2022-01-05 12:35");
//Rapor push olarak alınmak isteniyorsa ilgili url girilir
//request.setPushSettings(new PushSettings("https://webhook.site/8d7ed0f7"));
ResponseSendDynamicSms response = messenger.sendDynamicSms(request);
if(response.getErr() == null) {
System.out.println("PaketID : " + response.getPkgID());
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var dynamicSmsRequest = new SendDynamicSms();
dynamicSmsRequest.Content = "Deneme Mesajı";
dynamicSmsRequest.Sender = "Gönderen Başlığı";
//Kendi sistemindeki id ‘ler ile eşleştirme yapabilmek için kullanılan parametre
//dynamicSmsRequest.CustomId = "mesajID103";
//Title boş gönderilirse otomatik olarak yyyy-MM-dd hh:mm:ss formatını alır
dynamicSmsRequest.Title = "Test Gönderimi";
//Ticari gönderimlerde İYS sorgusu için Commercial alanı true gönderilmelidir
//dynamicSmsRequest.Commercial = true;
//Mesajların AHS sorgusuna sokulması istenmiyorsa true değeri girilmelidir.
//dynamicSmsRequest.SkipAhsQuery = true;
//İleri tarihli gönderimlerde kullanılır Yıl - Ay - Gün - Saat - Dakika - Saniye
//dynamicSmsRequest.SendingDate = new DateTime(2021, 06, 11, 10, 00, 00);
dynamicSmsRequest.Numbers = new List<SmsItem>() {
new SmsItem()
{
nr=905001234567,
msg="Sayın Ali Efe bu bir deneme mesajı"
},
new SmsItem()
{
nr=905009992211,
msg="Sayın Ayşe Ak bu bir deneme mesajı"
}
};
var dynamicSmsResponse = messenger.SendDynamicSms(dynamicSmsRequest);
if (dynamicSmsResponse.Err == null)
{
Console.WriteLine("Paket Id : " + dynamicSmsResponse.PackageId);
}
else
{
Console.WriteLine(
"Durum Statu : " + dynamicSmsResponse.Err.Status + "\n" +
"Durum Kodu : " + dynamicSmsResponse.Err.Code + "\n" +
"Durum Mesajı : " + dynamicSmsResponse.Err.Message
);
}
cmd | sendsms | ||||||
kullanici | Api kullanıcı adınız | ||||||
sifre | Api şifreniz | ||||||
mesaj | Mesaj metni | ||||||
baslik | Başlık adı. Kısa mesajlarınızı alan kişilere gözükecek gönderen ismidir. | ||||||
gsm | Kısa mesajı göndermek istediğiniz numara | ||||||
ahs | AHS sorgusu parametresi
| ||||||
nlss | Mesajın kodlanma biçimidir. 3 değer alabilir.
|
String | Mesajın başarılı olması durumunda paket id döner. Hata durumunda ilgili hata ile ilgili açıklama döner |
Get | https://[URL]:9588/direct/?cmd=sendsms&kullanici={USERNAME}&sifre={PASSWORD}&mesaj={MESAJ METNI}&gsm={TELEFON NUMARASI}&nlss={ENCODING}&baslik={SENDER}&ahs={AHS} |
Request
Response
String
Request
Response
ids | Raporlanmak istenilen paketlerin id leri (Opsiyonel) |
customIDs | Kullanıcı tarafından customID verilen paketlerin raporlanmasını sağlayan parametre (Opsiyonel) |
keyword | İçerik filtresi (Opsiyonel) |
sender | Gönderen başlığı filtresi (Opsiyonel) |
status | Paket durumu filtresi (Opsiyonel) Paket durumu filtrelerine bakınız |
startDate | Başlangıç tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
finishDate | Bitiş tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
pageIndex | İlgili sorgunun sayfa indeksi |
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 1000 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/list |
Request
{
"ids": [
0
],
"customIDs": [
"String"
],
"sender": "String",
"status": 0,
"startDate": "yyyy-MM-dd HH:mm",
"finishDate": "yyyy-MM-dd HH:mm",
"pageIndex": 0,
"pageSize": 0
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"id": 0,
"customID": "String",
"type": 1,
"uuid": "String",
"error": null,
"state": 0,
"title": "String",
"content": "String",
"senders": [
"String"
],
"encoding": 0,
"validity": 0,
"statistics": {
"total": 0,
"credit": 0,
"rCount": 0,
"delivered": 0,
"undelivered": 0
},
"isScheduled": 0,
"processInfo": {
"create": {
"date": "0001-01-01T00:00:00.000000"
},
"update": {
"date": "0001-01-01T00:00:00.000000"
}
},
"sendingDate": "0001-01-01T00:00:00",
"processingDate": "0001-01-01T00:00:00.000000"
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$request = new GetSmsReports();
$request->startDate = "2021-01-10 13:00";
$request->finishDate = "2021-06-10 13:00";
$request->pageIndex = 0;
$request->pageSize = 100;
//Eğer paket id sine göre sorgulamak istenirse
//$request->ids = [1110, 1234];
//Eğer kişisel id nize göre sorgulamak yapmak istenirse
//customID gönderiminde ids göndermeye gerek yoktur
//$request->customIDs = ["mesajId101","mesajId102"];
$response = $smsApi->getSmsReports($request);
if($response->err == null){
echo "totalRecord: ".$response->totalRecord."\n";
echo "Reports\n";
$reports = $response->list;
foreach($reports as $item){
echo "id: ".$item->id."\n";
echo "uuid: ".$item->uuid."\n";
echo "error: ".$item->error."\n";
echo "state: ".$item->state."\n";
echo "title: ".$item->title."\n";
echo "content: ".$item->content."\n";
echo "sender: ".$item->sender."\n";
echo "encoding: ".$item->encoding."\n";
echo "validity: ".$item->validity."\n";
echo "customID: ".$item->customID."\n";
echo "isScheduled: ".$item->isScheduled."\n";
echo "total: ".$item->statistics->credit."\n";
echo "credit: ".$item->statistics->total."\n";
echo "rCount: ".$item->statistics->rCount."\n";
echo "delivered: ".$item->statistics->delivered."\n";
echo "undelivered: ".$item->statistics->undelivered."\n";
echo "createDate: ".$item->createDate."\n";
echo "updateDate: ".$item->updateDate."\n";
echo "sendingDate: ".$item->sendingDate."\n";
echo "processingDate: ".$item->processingDate."\n";
}
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
RequestGetSmsReportList request = new RequestGetSmsReportList();
request.setStartDate("2022-01-01 00:00");
request.setFinishDate("2022-01-05 12:35");
request.setPageIndex(0);
request.setPageSize(100);
//Tarih yerine paket id ile sorgulanmak istenirse
//request.getIds().add(112045);
//request.getIds().add(112079);
//Eğer kişisel id nize göre sorgulamak yapmak istenirse
//customIDs gönderiminde ids göndermeye gerek yoktur
//request.getCustomIds().add("mesajId100");
//request.getCustomIds().add("mesajId101");
ResponseGetSmsReportList response = messenger.getSmsReportList(request);
if(response.getErr() == null) {
System.out.println("TotalRecord : " + response.getTotalRecord());
for (SmsReportList item : response.getList()) {
System.out.println("****Item****");
System.out.println("Id: " + item.getId());
System.out.println("Type: " + item.getType());
System.out.println("Uuid: " + item.getUuid());
System.out.println("State: " + item.getState());
System.out.println("Title: " + item.getTitle());
System.out.println("CustomId: " + item.getCustomID());
System.out.println("Content: " + item.getContent());
System.out.println("Sender: " + item.getSenders());
System.out.println("Encoding: " + item.getEncoding());
System.out.println("Validity: " + item.getValidity());
System.out.println("SendingDate" + item.getSendingDate());
System.out.println("ProcessingDate: " + item.getProcessingDate());
System.out.println("Statictics Credit: " + item.getStatistics().getCredit());
System.out.println("Statictics Total: " + item.getStatistics().getTotal());
System.out.println("Statictics Delivered: " + item.getStatistics().getDelivered());
System.out.println("Statictics Undelivered: " + item.getStatistics().getUndelivered());
System.out.println("Statictics RCount: " + item.getStatistics().getrCount());
}
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var getReportRequest = new GetSmsReport();
getReportRequest.StartDate = new DateTime(2021, 06, 01);
getReportRequest.FinishDate = new DateTime(2021, 07, 01);
getReportRequest.PageIndex = 0;
getReportRequest.PageSize = 100;
//Tarih yerine paket id ile sorgulanmak istenirse
//getReportRequest.Ids = new List<long>() { 112045, 112079 };
//Eğer kişisel id nize göre sorgulama yapmak istenirse
//customIDs gönderiminde ids göndermeye gerek yoktur
//getReportRequest.CustomIds = new List<string>() { "mesajID101", "mesajID102" };
var getReportResponse = messenger.GetSmsReport(getReportRequest);
if (getReportResponse.Err == null)
{
Console.WriteLine("TotalCount: " + getReportResponse.TotalCount);
foreach (ReportItem item in getReportResponse.List)
{
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("CustomId: " + item.CustomId);
Console.WriteLine("Type: " + item.Type);
Console.WriteLine("Uuid: " + item.Uuid);
Console.WriteLine("State: " + item.State);
Console.WriteLine("Title: " + item.Title);
Console.WriteLine("Content: " + item.Content);
Console.WriteLine("Sender: " + item.Sender);
Console.WriteLine("Encoding: " + item.Encoding);
Console.WriteLine("Validity: " + item.Validity);
Console.WriteLine("SendingDate" + item.SendingDate);
Console.WriteLine("ProcessingDate: " + item.ProcessingDate);
Console.WriteLine("Statictics Credit: " + item.Statictics.Credit);
Console.WriteLine("Statictics Total: " + item.Statictics.Total);
Console.WriteLine("Statictics Delivered: " + item.Statictics.Delivered);
Console.WriteLine("Statictics Undelivered: " + item.Statictics.Undelivered);
Console.WriteLine("Statictics RCount: " + item.Statictics.RCount);
}
}
else
{
Console.WriteLine(
"Durum Statu : " + getReportResponse.Err.Status + "\n" +
"Durum Kodu : " + getReportResponse.Err.Code + "\n" +
"Durum Mesajı : " + getReportResponse.Err.Message
);
}
pkgID | İlgili paketin id si (* Zorunlu)
| ||
customID | Kullanıcı tarafından customID verilen paketlerin doğrudan raporlanmasını sağlayan parametre (* Zorunlu)
| ||
target | Numara filtresi (Opsiyonel) | ||
state | Numaranın durum filtresi (Opsiyonel) Numara durum listesine bakınız | ||
pageIndex | İlgili sorgunun sayfa indeksi | ||
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 1000 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/list-item |
Request
{
"pkgID": 0,
"customID": "String",
"target": "String",
"state": 0,
"pageIndex": 0,
"pageSize": 0
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"id": "String",
"msg": null,
"error": null,
"state": "String",
"credit": 0,
"sender": "String",
"target": "String",
"setState": 0,
"sendingDate": "0001-01-01T00:00:00",
"deliveryDate": "0001-01-01T00:00:00",
"processingDate": "0001-01-01T00:00:00"
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$request = new GetSmsReportDetails();
$request->pkgID = 78;
$request->pageIndex = 0;
$request->pageSize = 100;
//Eğer kişisel id nize göre sorgulamak yapmak istenirse
//customID gönderiminde pkgID göndermeye gerek yoktur
//$request->customID = "mesajId102";
$response = $smsApi->getSmsReportDetails($request);
if($response->err == null){
echo "totalRecord: ".$response->totalRecord."\n";
echo "Reports\n";
$reports = $response->list;
foreach($reports as $item){
echo "id: ".$item->id."\n";
echo "msg: ".$item->msg."\n";
echo "error: ".$item->error."\n";
echo "state: ".$item->state."\n";
echo "credit: ".$item->credit."\n";
echo "sender: ".$item->sender."\n";
echo "target: ".$item->target."\n";
echo "setState: ".$item->setState."\n";
echo "sendingDate: ".$item->sendingDate."\n";
echo "deliveryDate: ".$item->deliveryDate."\n";
echo "processingDate: ".$item->processingDate."\n";
}
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
RequestGetSmsReportDetailList request = new RequestGetSmsReportDetailList();
request.setId(10415210);
request.setPageIndex(0);
request.setPageSize(100);
//Eğer kişisel id nize göre sorgulamak yapmak istenirse
//customID gönderiminde pkgID göndermeye gerek yoktur
//request.setCustomID("mesajId102");
ResponseGetSmsReportDetailList response = messenger.getSmsReportDetailList(request);
if(response.getErr() == null) {
System.out.println("TotalRecord : " + response.getTotalRecord());
for (SmsReportItem item : response.getList()) {
System.out.println("Id: " + item.getId());
System.out.println("State: " + item.getState());
System.out.println("Credit: " + item.getCredit());
System.out.println("Sender: " + item.getSender());
System.out.println("Target: " + item.getTarget());
System.out.println("SetState: " + item.getSetState());
System.out.println("SendingDate: " + item.getSendingDate());
System.out.println("DeliveryDate: " + item.getDeliveryDate());
System.out.println("ProcecingDate: " + item.getProcessingDate());
System.out.println("SendingDate" + item.getSendingDate());
}
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var getReportDetailRequest = new GetSmsReportDetail();
getReportDetailRequest.PackageId = 112045;
getReportDetailRequest.PageIndex = 0;
getReportDetailRequest.PageSize = 100;
//Eğer kişisel id nize göre sorgulamak yapmak istenirse
//CustomId gönderiminde PackageId göndermeye gerek yoktur
//getReportDetailRequest.CustomId = "mesajId101";
var getReportDetailResponse = messenger.GetSmsReportDetail(getReportDetailRequest);
if (getReportDetailResponse.Err == null)
{
Console.WriteLine("TotalCount: " + getReportDetailResponse.TotalCount);
foreach (ReportDetailItem item in getReportDetailResponse.List)
{
Console.WriteLine("Id: " + item.Id);
Console.WriteLine("State: " + item.State);
Console.WriteLine("Credit: " + item.Credit);
Console.WriteLine("Sender: " + item.Sender);
Console.WriteLine("Message: " + item. Message);
Console.WriteLine("Error: " + item. Error);
Console.WriteLine("Target: " + item.Target);
Console.WriteLine("SetState: " + item.SetState);
Console.WriteLine("SendingDate: " + item.SendingDate);
Console.WriteLine("DeliveryDate: " + item.DeliveryDate);
Console.WriteLine("ProcecingDate: " + item.ProcessingDate);
Console.WriteLine("SendingDate" + item.SendingDate);
}
}
else
{
Console.WriteLine(
"Durum Statu : " + getReportDetailResponse.Err.Status + "\n" +
"Durum Kodu : " + getReportDetailResponse.Err.Code + "\n" +
"Durum Mesajı : " + getReportDetailResponse.Err.Message
);
}
startDate | Başlangıç tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
finishDate | Bitiş tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/summary |
Request
{
"startDate": "yyyy-MM-dd HH:mm",
"finishDate": "yyyy-MM-dd HH:mm"
}
Response
{
"data": {
"total": 0,
"delivered": 0,
"undelivered": 0,
"pending": 0,
"rCount": 0,
"credit": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
keyword | Gönderen başlıklarını kelimeye göre filtrelemek için kullanılır (Opsiyonel) |
status | Gönderen başlıklarını durumlarına göre filtrelemek için kullanılır (Opsiyonel) |
pageIndex | İlgili sorgunun sayfa indeksi |
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 100 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/list-sender |
Request
{
"keyword": "String",
"status": 0,
"pageIndex": 0,
"pageSize": 10
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"uuid": "String",
"status": 0,
"title": "String"
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$response = $smsApi->getSenders();
if($response->err == null){
echo "Toplam Kayıt: ".$response->totalRecord."\n";
echo "Senders\n";
$senders = $response->list;
foreach($senders as $item){
echo "uuid: ".$item->uuid."\n";
echo 'status: '.$item->status."\n";
echo 'title: '.$item->title."\n";
}
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
ResponseGetSenders response = messenger.getSenders();
if(response.getErr() == null) {
System.out.println("TotalRecord : " + response.getTotalRecord());
for (Sender item : response.getList()) {
System.out.println("****Item****");
System.out.println("Statu : " + item.getStatus());
System.out.println("Uuid : " + item.getUuid());
System.out.println("Title : " + item.getTitle());
}
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var getSendersResponse = messenger.GetSenders();
if (getSendersResponse.Err == null)
{
foreach (Sender item in getSendersResponse.Senders)
{
Console.WriteLine(
"Title : " + item.Title + "\n" +
"Status : " + item.Status + "\n" +
"Uuid : " + item.Uuid
);
}
}
else
{
Console.WriteLine(
"Durum Statu : " + getSendersResponse.Err.Status + "\n" +
"Durum Kodu : " + getSendersResponse.Err.Code + "\n" +
"Durum Mesajı : " + getSendersResponse.Err.Message
);
}
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Get | https://[URL]:9588/user/credit |
Request
Response
{
"data": {
"credit": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$response = $smsApi->getCredit();
if($response->err == null){
echo "Credit: ".$response->credit."\n";
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
ResponseGetCredit response = messenger.getCredit();
if(response.getErr() == null) {
System.out.println("Kredi : " + response.getCredit());
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var getCreditResponse = messenger.GetCredit();
if (getCreditResponse.Err == null)
{
Console.WriteLine(
"Credit : " + getCreditResponse.Credit
);
}
else
{
Console.WriteLine(
"Durum Statu : " + getCreditResponse.Err.Status + "\n" +
"Durum Kodu : " + getCreditResponse.Err.Code + "\n" +
"Durum Mesajı : " + getCreditResponse.Err.Message
);
}
id | Mesaj paketinin numarası.
| ||
customID | Mesaj paketinin kullanıcı tarafındaki numarası
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/sms/cancel |
Request
{
"id": 0,
"customID": "string"
}
Response
{
"data": {
"status": 0
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
$smsApi = new SmsApi("[URL]","username","password");
$response = $smsApi->cancel(12555646);
//CustomID ye göre paket iptal edilmek istenirse
//$response = $smsApi->cancelCustomId("mesajId100");
if($response->err == null){
echo "Durum: ".$response->status."\n";
}else{
echo "Status: ".$response->err->status."\n";
echo "Code: ".$response->err->code."\n";
echo "Message: ".$response->err->message."\n";
}
Messenger messenger = new Messenger("[URL]","username","password");
ResponseCancelSms response = messenger.cancelSms(123456);
//CustomID ye göre paket iptal edilmek istenirse
//ResponseCancelSms response = messenger.cancelSms("mesajId100");
if(response.getErr() == null) {
System.out.println("Status : " + response.getStatus());
}else {
System.out.println("Status : " + response.getErr().getStatus());
System.out.println("Message : " + response.getErr().getMessage());
System.out.println("Code : " + response.getErr().getCode());
}
var messenger = new Messenger("[URL]","username", "password");
var cancelResponse = messenger.Cancel(11715767);
//CustomID ye göre paket iptal edilmek istenirse
//var cancelResponse = messenger.Cancel("mesajID101");
if (cancelResponse.Err == null)
{
Console.WriteLine("Mesaj İptal Edildi: " + cancelResponse.Status);
}
else
{
Console.WriteLine(
"Durum Statu : " + cancelResponse.Err.Status + "\n" +
"Durum Kodu : " + cancelResponse.Err.Code + "\n" +
"Durum Mesajı : " + cancelResponse.Err.Message
);
}
gsm | Eklenecek kişinin telefon numarası | ||||||
firstName | Eklenecek kişinin ismi | ||||||
lastName | Eklenecek kişinin soyismi | ||||||
groupUUIDs | İlgili kişi gruba eklenmek isteniyorsa grubların ait uuid si | ||||||
isInBlacklist | İlgili kişinin kara listeye eklenmesini belirtir. İlgili kişi karalisteye eklenecekse true gönderilmelidir | ||||||
iys | İlgili kişi İYS ye senkronizasyonunu belirten alandır. İYS ile entegre olunmayacak ise bu değer null gönderilebilir
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/contact/create |
Request
{
"gsm": "String",
"firstName": "String",
"lastName": "String",
"groupUUIDs": [
"String"
],
"isInBlacklist": false,
"iys": {
"c": 0,
"src": 0,
"send": false
}
}
Response
{
"data": {
"uuid": "String",
"firstName": "String",
"lastName": "String",
"gsm": "String",
"groups": [
"String"
],
"isInBlacklist": 0,
"iys": {
"c": 0,
"st": 0,
"src": 0,
"send": 0
}
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
uuid | İlgili kaydın benzersiz id si | ||||||
gsm | İlgili kaydın telefon numarası | ||||||
firstName | İlgili kaydın ismi | ||||||
lastName | İlgili kaydın soyismi | ||||||
groupUUIDs | İlgili kaydın ekleneceği grupların id leri | ||||||
isInBlacklist | İlgili kaydın karalisteye eklenmesi. İlgili kayıt karalisteye eklenecekse true gönderilmelidir | ||||||
iys | İlgili kaydın YS ye senkronizasyonunu belirten alandır. İYS ile entegre olunmayacak ise bu değer null gönderilebilir
|
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/contact/update |
Request
{
"uuid": "String",
"gsm": "String",
"firstName": "String",
"lastName": "String",
"groupUUIDs": [
"String"
],
"isInBlacklist": false,
"iys": {
"c": 0,
"src": 0,
"send": false
}
}
Response
{
"data": {
"uuid": "String",
"firstName": "String",
"lastName": "String",
"gsm": "String",
"groups": [
"String"
],
"isInBlacklist": 0,
"iys": {
"c": 0,
"st": 0,
"src": 0,
"send": 0
}
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
status | Kişi filtresi. Kişi filtre parametrelerine gözat. (Opsiyonel) |
iysState | İYS durum filtresi. İYS durumları için gözat (Opsiyonel) |
exitType | Mesaj çıkış isteği filtresi. gözat (Opsiyonel) |
groupUUID | Grubun benzersiz id si. Gruba ait kişilerin listeleneceği zaman gönderilecek parametredir. (Opsiyonel) |
pageIndex | İlgili sorgunun sayfa indeksi |
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 1000 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/contact/list |
Request
{
"status": 0,
"iysState": 0,
"exitType": 0,
"groupUUID": "String",
"pageIndex": 0,
"pageSize": 10
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"uuid": "String",
"firstName": "String",
"lastName": "String",
"gsm": "String",
"groups": [
"String"
],
"isInBlacklist": 0,
"exitInfo": {
"date": "0001-01-01T00:00:00",
"type": 0
},
"iys": {
"c": 0,
"st": 0,
"src": 0,
"send": 0
}
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
keyword | Grup adına göre filtreleme yapılmak istendiğinde gönderilir. (Opsiyonel) |
parentUUID | Grubun bağlı olduğu üst grubun benzersiz id si. (Opsiyonel) |
pageIndex | İlgili sorgunun sayfa indeksi |
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 1000 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/contact/list-group |
Request
{
"keyword": "String",
"parentUUID": "String",
"pageIndex": 0,
"pageSize": 10
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"uuid": "String",
"stats": {
"contactCount": 0
},
"title": "String",
"isParent": 0,
"isShared": 0,
"parentInfo": null
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
keyword | Sorgulanmak sitenen anahtar kelime |
startDate | Başlangıç tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
finishDate | Bitiş tarihi. Tarih formatı yyyy-MM-dd HH:mm şeklinde olmalıdır. |
pageIndex | İlgili sorgunun sayfa indeksi |
pageSize | Sayfalama boyutu. Minimum 10 ve Maksimum 1000 değerini alabilir |
data | İsteğin başarılı olması durumunda dönen veri. Hatalı durumlarda null döner
| ||||||||||||||||||||||
err | İsteğin hatalı olması durumunda dönen veri. Başarılı durumlarda null döner
|
Post | https://[URL]:9588/mo/list-request |
Request
{
"keyword": "String",
"startDate": "yyyy-MM-dd HH:mm",
"finishDate": "yyyy-MM-dd HH:mm",
"pageIndex": 0,
"pageSize": 0
}
Response
{
"data": {
"stats": {
"totalRecord": 0
},
"list": [
{
"gsm": 0,
"msg": "String",
"state": 0,
"keyword": "String",
"network": "String",
"shortNr": 0,
"processInfo": {
"create": {
"date": "0000-00-00T00:00:00.000000+00:00"
}
}
}
]
},
"err": {
"code": "String",
"status": 0,
"message": "String"
}
}
Request
Response
Status | Code | Açıklama |
---|---|---|
400 | ERR_BAD_REQUEST | Hatalı istek gereken şartlar yerine getirilmemiş veya illegal bir istekte bulunuluyor. |
417 | ERR_INVALID_PARAM | Hatalı parametre message parametresindeki açıklamaya bakınız. |
403 | ERR_UNAUTHORIZED_REQUEST | Kullanıcı adı veya parola hatalı |
401 | ERR_USER_NOT_AUTHORIZED | Kullanıcının bu işlemi yapmaya yetkisi yok. |
417 | ERR_INVALID_SMS_SENDER | Hatalı gönderen başlığı. |
417 | ERR_EMPTY_SMS_PACKAGE | İlgili pakette geçerli numara bulunamadı. |
417 | ERR_INVALID_SMS_SENDING_DATE | Sms gönderim tarihi geçersiz ya da mevcut zamandan daha eski. |
417 | ERR_USER_CREDIT_REQUIRED | Kullanıcı yeterli krediye sahip değil. |
417 | ERR_PARENT_USER_CREDIT_REQUIRED | Üst kullanıcı yeterli krediye sahip değil. |
417 | ERR_USER_BRAND_CODE_NOT_FOUND | Kullanıcı IYS marka kodu tanımlı değil |
400 | ERR_SMS_PKG_CUSTOM_ID_DUPLICATION | Belirtilen özel id ile daha önce oluşturulmuş bir sms paketi sistemde zaten mevcut. |
400 | ERR_INVALID_DATE_RANGE | Geçersiz tarih aralığı. |
400 | ERR_SMS_PKG_NOT_FOUND | Sms paketi mevcut değil. |
400 | ERR_SMS_PKG_NOT_CHANGEABLE | Sms durumu değiştirilebilir pozisyonda değil. |
400 | ERR_USER_IYS_SETTINGS_NOT_FOUND | Kullanıcı IYS tanımları mevcut değil. |
400 | ERR_INVALID_PRICING_PLAN | Fiyat planı geçersiz. |
400 | ERR_CREDIT_PLAN_NOT_FOUND | Kredi planı mevcut değil. |
417 | ERR_USER_NOT_FOUND | Kullanıcı bulunamadı. |
417 | ERR_SMS_PKG_DUPLICATION | Mevcut sms ilgili numaralara son 30 dk içersinde zaten gönderildi |
400 | ERR_MO_NOT_FOUND | MO kısa numara mevcut değil. |
417 | ERR_SMS_PKG_CREATING_FAILED | Sms paketi oluşturulamadı |
503 | ERR_SYSTEM_MAINTENANCE | Sistem bakım modunda daha sonra tekrar denenmeli. |
404 | ERR_NOT_FOUND | İstek atılan url geçersiz |
403 | ERR_DAILY_REQUEST_LIMIT | Günlük rapor sorgulama limiti aşıldı |
500 | ERR_INTERNAL_SERVER | Sunucu hatası |
Request
Response
Request
Response
Default
0-155 Karakter | 1 Mesaj Uzunluğu |
156-301 Karakter | 2 Mesaj Uzunluğu |
302-454 Karakter | 3 Mesaj Uzunluğu |
455-607 Karakter | 4 Mesaj Uzunluğu |
608-760 Karakter | 5 Mesaj Uzunluğu |
761-913 Karakter | 6 Mesaj Uzunluğu |
Türkçe
0-150 Karakter | 1 Mesaj Uzunluğu |
151-293 Karakter | 2 Mesaj Uzunluğu |
294-442 Karakter | 3 Mesaj Uzunluğu |
443-591 Karakter | 4 Mesaj Uzunluğu |
592-740 Karakter | 5 Mesaj Uzunluğu |
741-889 Karakter | 6 Mesaj Uzunluğu |
Unicode
0-65 Karakter | 1 Mesaj Uzunluğu |
66-129 Karakter | 2 Mesaj Uzunluğu |
130-196 Karakter | 3 Mesaj Uzunluğu |
197-263 Karakter | 4 Mesaj Uzunluğu |
264-330 Karakter | 5 Mesaj Uzunluğu |
331-397 Karakter | 6 Mesaj Uzunluğu |
Paket Durum Filtreleri
Tüm Mesajlar | 0 |
Kuyrukta | 1 |
İşlemde | 2 |
İleri tarihli | 3 |
Periyodik | 4 |
Tamamlanmış | 5 |
İptal | 6 |
Başarısız | 7 |
Paket Durumları
İptal Edildi | -4 |
Gönderim Başarısız Oldu | -3 |
Paket Oluşturma Başarısız oldu | -2 |
Paket Operatör Tarafından Reddedildi | -1 |
Kaydediliyor | 0 |
Beklemede | 1 |
Kuyruklanıyor | 2 |
Gönderiliyor | 3 |
Gönderildi | 4 |
Kısmen Raporlandı | 5 |
Tamamlandı | 6 |
Item Durumları
İptal Edildi | -2 |
Operatör Tarafından Reddedildi | -1 |
Beklemede | 0 |
Gönderiliyor | 1 |
Gönderildi | 2 |
Numaraya İletildi | 3 |
Numaraya İletilemedi | 4 |
Zamanaşımına Uğradı | 5 |
Sender
0 | Beklemede |
1 | Onaylandı |
2 | Reddedildi |
3 | Yasaklı |
İYS Alıcı Tipleri
0 | Bireysel |
1 | Ticari |
İYS Kaynak Tipleri
0 | HS_2015: Alıcı, 1 Mayıs 2015 tarihi öncesinde onaylı olarak kaydedilmiştir. |
1 | HS_KARAR: İzin durumu, hizmet sağlayıcının kendi isteğiyle RET olarak belirlenmiştir. Hizmet sağlayıcı, ilk izin ekleme işleminde HS_KARAR kaynak(source) değerini kullanamamaktadır. |
2 | HS_FIZIKSEL_ORTAM: İzin, hizmet sağlayıcı tarafından fiziksel ortamda alınmıştır. |
3 | HS_ISLAK_IMZA: İzin, alıcının bir formu veya anketi imzalaması üzerine alınmıştır. |
4 | HS_ETKINLIK: İzin, hizmet sağlayıcının düzenlediği bir etkinlikte alınmıştır. |
5 | HS_ATM: İzin, hizmet sağlayıcıya ait yerleşik ATM cihazıyla alınmıştır. |
6 | HS_EORTAM: İzin, hizmet sağlayıcıya ait bir elektronik ortamda alınmıştır. |
7 | HS_WEB: İzin, hizmet sağlayıcının web sitesi üzerinde yapılan bir işlemle alınmıştır. |
8 | HS_MOBIL: İzin, hizmet sağlayıcıya ait mobil uygulama üzerinden alınmıştır. |
9 | HS_MESAJ: İzin, hizmet sağlayıcıya ait kısa mesaj numarası üzerinden alınmıştır. |
10 | HS_EPOSTA: İzin, hizmet sağlayıcıya ait e-posta vasıtasıyla alınmıştır. |
11 | HS_CAGRI_MERKEZI: İzin, hizmet sağlayıcıya bağlı bir çağrı merkezinde sesle veya numara tuşlamayla alınmıştır. |
12 | HS_SOSYAL_MEDYA: İzin, hizmet sağlayıcıya ait sosyal medya aracı üzerinden alınmıştır. |
İYS Durumları
-2 | Geçersiz numara |
-1 | Reddedildi |
0 | İşlenmeyi / senkronizasyonu bekliyor |
1 | İşleniyor |
2 | Kuyruğa alındı |
3 | Kabul edildi |
4 | Tanımsız |
Kişi Filtreleri
0 | Tüm Kişiler |
1 | Beyaz Liste |
2 | Kara Liste |
Çıkış İsteği Durumları
0 | Manuel çıkış istekleri |
1 | IYS çıkış istekleri |
2 | MO çıkış istekleri |
3 | Web çıkış istekleri |
Push Settings Response Parametreleri
userID | Kullanıcının id si | ||||||||||||
pkg |
Sms paketinin bilgilerini içeren obje
|
||||||||||||
items |
Paketin içerisinde gönderilen numaraların objesi
|
{
"userID": 0,
"pkg": {
"id": 0,
"state": 0,
"statistics": {
"total": 0,
"delivered": 0,
"undelivered": 0
}
},
"items": [
{
"id": "String",
"nr": "String",
"status": 0,
"lastUpdate": "0001-01-01T00:00:00.000Z"
}
]
}
SetState Durumları
0 | Beklemede |
1 | Gönderiliyor |
2 | Gönderildi |
3 | Raporlanıyor |
5 | Bitti |
MO Durumları
-2 | Başarısız |
-1 | Eşleşme yok |
0 | Beklemede |
1 | İşleniyor |
2 | Tamamlandı |