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/create/json

İstek İçeriği (Body)

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "consent": {
      "brandCode": 696422,
      "list": [
        {
          "recipient": "+90505xxxxxxx veya [email protected]",
          "recipientType": "BIREYSEL",
          "source": "HS_EORTAM",
          "status": "ONAY",
          "type": "MESAJ",
          "consentDate": "2026-01-07 23:50:00"
        }
      ]
    }
  }
}

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.

consent

İYS'ye aktarılacak izin bilgilerini içeren etiket.

• brandCode: İzin bilgileri iletilecek markanın kodu.

• list: İzin bilgilerini içeren etiket. list etiketi içerisinde birden fazla izin bilgisi gönderilebilir.

  list

  • recipient: İzin bilgisi iletilecek cep telefonu numarası veya e-posta adresi.
  • recipientType: İzin bilgisi iletilecek kişinin türü. BIREYSEL veya TACIR değerlerini alabilir.
  • source: İzin bilgisinin alındığı kaynak. (Örneğin: HS_EORTAM, HS_FIZIKSEL_ORTAM, vs.)

    Kaynak	Açıklama
    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.
    HS_FIZIKSEL_ORTAM	İzin, hizmet sağlayıcı tarafından fiziksel ortamda alınmıştır.
    HS_ISLAK_IMZA	İzin, alıcının bir formu veya anketi imzalaması üzerine alınmıştır.
    HS_ETKINLIK	İzin, hizmet sağlayıcının düzenlediği bir etkinlikte alınmıştır.
    HS_ATM	İzin, hizmet sağlayıcıya ait yerleşik ATM cihazıyla alınmıştır.
    HS_EORTAM	İzin, hizmet sağlayıcıya ait bir elektronik ortamda alınmıştır.
    HS_WEB	İzin, hizmet sağlayıcının web sitesi üzerinde yapılan bir işlemle alınmıştır.
    HS_MOBIL	İzin, hizmet sağlayıcıya ait mobil uygulama üzerinden alınmıştır.
    HS_MESAJ	İzin, hizmet sağlayıcıya ait kısa mesaj numarası üzerinden alınmıştır.
    HS_EPOSTA	İzin, hizmet sağlayıcıya ait e-posta vasıtasıyla alınmıştır.
    HS_CAGRI_MERKEZI	İzin, hizmet sağlayıcıya bağlı bir çağrı merkezinde sesle veya numara tuşlamayla alınmıştır.
    HS_SOSYAL_MEDYA	İzin, hizmet sağlayıcıya ait sosyal medya aracı üzerinden alınmıştır.

  • status: İzin durumu. ONAY veya RET değerlerini alabilir.
  • type: İzin türü. MESAJ, EPOSTA veya ARAMA değerlerini alabilir.
  • consentDate: İzin veya ret işleminin gerçekleştiği tarih ve saat bilgisi. Format: YYYY-AA-GG SS:DD:DD, 3 günden eski olamaz.

Sunucu yanıtı

{
  "response": {
    "status": {
      "code": 200,
      "message": "İşlem başarılı"
    }
  }
}

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.

Hata Kodları

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

Hata Kodu	Mesaj	Açıklama
400	İstek çözümlenemedi	POST 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.
403	Aktif abonelik bulunamadı.	Eğer hesabınızda aktif bir abonelik yoksa bu hatayı alırsınız.
404	API istek yapılan yönteme sahip değil	Eğer bu hatayı alıyorsanız istek yaptığınız adresi tekrar kontrol edin yanlış bir adrese istek yapıyor olabilirsiniz.
405	Bu işlemi yapmak için, abonelik paketinizde yeterli kota bulunmamaktadır.	Abonelik paketinizin limitini aştığınızda bu hata döner.
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.
475	Alıcı sayısı 5000 kişiyi geçemez.	Tek bir istekte en fazla 5000 alıcıya işlem yapabilirsiniz.