Ana içeriğe geç

JSON Post API

SMS gönderilmesini istemediğiniz bir cep telefonu numarasını, HTTP protokolünün POST metodunu kullanarak, JSON formatında ileterek engellenmiş numara listenize eklemek isterseniz, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres​

POSThttps://api.iletimerkezi.com/v1/consent/show/json

İstek İçeriği (Body)​

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "consent": {
      "brandCode": "696422",
      "type": "MESAJ",
      "recipient": "+90505xxxxxxx veya [email protected]",
      "recipientType": "BIREYSEL"
    }
  }
}

Tanımlar​

Sunucuya yapılacak olan istek request etiketi ile sarmalanmalıdır. Bu etiketin alt etiketlerinin tanımları aşağıdaki gibidir:

authentication​

İstek yapılan işleme dair yetki alabilmek için gönderilmesi gereken kullanıcı bilgileridir. Alt etiketleri aşağıdaki gibidir:

  • key: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.

  • hash: iletimerkezi.com panelinize giriş yaptıktan sonra ayarlar bölümünden oluşturabileceğiniz API Anahtar ve Gizli Anahtar kullanılarak oluşturulmuş hash bu alana yazılmalıdır. İstek yapılırken gönderilmesi zorunludur.

Sorgulanacak izin bilgilerini içeren etiket.

  • brandCode: İzin bilgileri sorgulanacak markanın kodu.
  • type: İzin türü. MESAJ, EPOSTA veya ARAMA değerlerini alabilir.
  • recipient: İzin bilgisi sorgulanacak cep telefonu numarası veya e-posta adresi.
  • recipientType: İzin bilgisi sorgulanacak liste türü. BIREYSEL veya TACIR değerlerini alabilir.

Sunucu yanıtı​

{
  "response": {
    "status": {
      "code": 200,
      "message": "İşlem başarılı"
    },
    "consent": {
      "brandCode": 696422,
      "recipient": "+90505xxxxxxx veya [email protected]",
      "recipientType": "BIREYSEL",
      "type": "MESAJ",
      "status": "ONAY",
      "source": "HS_WEB",
      "consentDate": "2025-12-10 00:00:00"
    }
  }
}

Tanımlar​

Sunucudan gelen yanıt her zaman response etiketi ile sarmalanmıştır. Bu etiketin alt etiketlerinin tanımı aşağıdaki gibidir:

status​

İşlem durumu ile ilgili bilgi içerir. Bu etiket ile döndürülen değerler aynı zamanda HTTP yanıtının başlık bilgisine bakılarak da elde edilebilir. Bu etiket, yapılan her istekte standart olarak döndürülür. Alt etiketleri aşağıdaki gibidir

  • code: İşlem durumunu belirten numerik değerdir.
  • message: İşlem durumu hakkında bilgi mesajı içerir.

Sorgulanacak izin bilgilerini içeren etiket.

  • brandCode: İzin bilgileri gösterilen markanın kodu.
  • type: İzin türü. MESAJ, EPOSTA veya ARAMA değerlerinden biri olabilir.
  • recipient: İzin bilgisi sorgulanan cep telefonu numarası veya e-posta adresi.
  • recipientType: İzin bilgisi sorgulanan liste türü. BIREYSEL veya TACIR
  • status: İzin durumu. ONAY veya RET değerlerini alabilir.
  • source: İzin bilgisinin alındığı kaynak. (Örneğin: HS_EORTAM, HS_FIZIKSEL_ORTAM, vs.)
  • consentDate: İzin veya ret işleminin gerçekleştiği tarih ve saat bilgisi. Format: YYYY-AA-GG SS:DD:DD

Hata Kodları​

Eğer istek sonucu olumsuz ise sunucu tarafından size dönücek hata kodları ve mesajlar aşağıdaki gibidir.

Hata KoduMesajAçıklama
400İstek çözümlenemediPOST ettiğiniz JSON'in yapısındaki hatadan kaynaklanır. Bu hatalar genellikle, yanlış yazılan JSON etiketi, düzgün kapatılmayan XML etiketi veya CDATA kullanılmadan JSON'in yapısını bozabilecek bir karakterin kullanımından kaynaklanır.
401Üyelik bilgileri hatalıPOST ettiğiniz JSON'in authentication etiketi içerisinde göndermiş olduğunuz bilgileri doğrulayamadığımızda bu hatayı veriyoruz, eğer hesabınızda sabit IP tanımladıysanız ve farklı bir IP üzerinden istek yapıyorsanız yine bu hatayı alırsınız.
403Aktif abonelik bulunamadı.Eğer hesabınızda aktif bir abonelik yoksa bu hatayı alırsınız.
404API istek yapılan yönteme sahip değilEğer bu hatayı alıyorsanız istek yaptığınız adresi tekrar kontrol edin yanlış bir adrese istek yapıyor olabilirsiniz.
422İstekte gönderilen bazı değerler doğrulanamadı.Yapmış olduğunuz isteğin içeriğinde doğrulamadan geçemeyen değerler içerdiğini belirtir. İsteğin içeriğini (body) ve gönderilen değerleri tekrar kontrol etmenizi öneririz.