JSON Post API

Engellediğiniz cep telefonu numaralarının listesini, HTTP protokolünün POST methodunu kullanarak, JSON formatında almak için, aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres

POSThttps://api.iletimerkezi.com/v1/get-blacklist/json

İstek İçeriği (Body)

Eğer API Anahtarı kullanılarak işlem yapıyorsanız isteğin içeriği

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "blacklist": {
      "page": "",
      "rowCount": ""
    }
  }
}

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.

blacklist

Listeye eklenicek numarayı içeren etiket.

• page: Arama sonuç sayfasını ifade eder. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1’dir.
• rowCount: Bir arama sonuç sayfasındaki kişi adedini belirtir. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1000’dir. Maksimum değeri 1000’dir. Eğer 1000’den fazla kişi varsa ayrı bir istek ile diğer arama sonuç sayfaları sorgulanmalıdır.

Sunucu yanıtı

{
  "response": {
    "status": {
      "code": "",
      "message": ""
    },
    "blacklist": {
      "count": "",
      "number": []
    }
  }
}

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.

blacklist

Engellenmiş numara listesini ifade eder. Alt etiketleri aşağıdaki gibidir.

• count: Toplam engellenen kişi sayısını ifade eder.
• number: Engellenen numara bilgisini 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.

code	message	Açıklama
400	İstek çözümlenemedi	POST ettiğiniz XML'in yapısındaki hatadan kaynaklanır. Bu hatalar genellikle, yanlış yazılan XML etiketi, düzgün kapatılmayan XML etiketi veya CDATA kullanılmadan XML'in yapısını bozabilecek bir karakterin kullanımından kaynaklanır.
401	Üyelik bilgileri hatalı	POST ettiğiniz XML'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.
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.

Örnek İstek

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "blacklist": {
      "page": 1,
      "rowCount": 5
    }
  }
}

Örnek Başarılı Yanıt

{
  "response": {
    "status": {
      "code": 200,
      "message": "İşlem başarılı"
    },
    "blacklist": {
      "count": "7906",
      "number": [
        "+905050047824",
        "+905050047824",
        "+905050047824",
        "+905050047824",
        "+905050047824"
      ]
    }
  }
}

Örnek Hatalı Yanıt

{
  "response": {
    "status": {
      "code": 401,
      "message": "Üyelik bilgileri hatalı"
    }
  }
}