Skip to main content

JSON Post API

Belirttiğiniz tarih aralığına göre göndermiş olduğunuz SMS paketlerinin durumunu, HTTP protokolünün POST metodunu kullanarak, JSON formatında almak isterseniz aşağıdaki yönergeleri takip edebilirsiniz.

İstek yapılacak adres​

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

İstek İçeriği (Body)​

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "filter": {
      "start": "",
      "end": "",
      "page": 1
    }
  }
}

Tanımlar​

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

authentication​

Contains information about the transaction status. The values ​​returned with this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned as standard in every request made. Its subtags are as follows

  • key: After logging into your iletimerkezi.com panel, the API Key that you can create from the settings section should be written in this field. It is mandatory to send it when making a request.

  • hash: After logging into your iletimerkezi.com panel, the hash created using the API Key and Secret Key, which you can create from the settings section, should be written in this field. It is mandatory to send it when making a request.

filter​

Arama sonuçlarını filtrelemek için kullanılır. Bu etiketin alt etiketleri aşağıdaki gibidir:

  • start: Başlangıç tarihini ifade eder. İstek yapılırken gönderilmesi zorunludur. Y-m-d (2024-09-27) formatında olmalıdır.
  • end: Bitiş tarihini ifade eder. İstek yapılırken gönderilmesi zorunludur. Y-m-d (2024-09-27) formatında olmalıdır.
  • page: Rapor sayfasını ifade eder. İstek yapılırken gönderilmesi zorunlu değildir. Varsayılan değeri 1'dir.

Sunucu yanıtı​

{
  "response": {
    "status": {
      "code": 200,
      "message": "İşlem başarılı"
    },
    "count": 2,
    "orders": [
      {
        "id": 89,
        "status": 113,
        "total": 1,
        "delivered": 0,
        "undelivered": 0,
        "waiting": 1,
        "submitAt": "2024-11-12 02:04:08",
        "sendAt": "2024-11-12 02:04:08",
        "sender": "eMarka"
      },
      {
        "id": 98,
        "status": 113,
        "total": 1,
        "delivered": 0,
        "undelivered": 0,
        "waiting": 1,
        "submitAt": "2024-11-13 19:04:08",
        "sendAt": "2024-11-13 19:04:08",
        "sender": "eMarka"
      }
    ]
  }
}

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​

Contains information about the transaction status. The values ​​returned with this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned as standard in every request made. Its subtags are as follows

  • code: It is a numeric value indicating the process status.
  • message: Contains information message about the process status.

count​

Belirttiğiniz tarih aralığına göre toplamda kaç adet SMS paketi olduğunu ifade eder.

orders​

İşlem başarılı olarak tamamlandıysa oluşturulan SMS paketi özet bilgisini içerir. İşlem başarısızsa bu etiket döndürülmez. Alt etiketleri aşağıdaki gibidir:

  • id: Siparişi ifade eden eşsiz numerik değerdir.

  • status: Siparişin genel gönderim durumunu belirten numerik değerdir. Aşağıdaki tabloda bu etiketin alabileceği değerler ve ifade ettikleri anlamlar listelenmiştir.

    Durum KoduDurum Mesajı
    113Siparişin gönderimi devam ediyor
    114Siparişin gönderimi tamamlandı
    115Sipariş gönderilemedi

  • total: Paketin içerdiği toplam alıcı sayısını ifade eder.

  • delivered: Başarılı bir şekilde ulaşan alıcı sayısını ifade eder.

  • undelivered: İletilemeyen alıcı sayısını ifade eder.

  • waiting: Gönderimi bekleyen alıcı sayısını ifade eder.

  • submitAt: Paketin oluşturulma tarihini ifade eder.

  • sendAt: Paketin gönderim tarihini ifade eder.

  • sender: Paketin gönderiminde kullanılan başlık bilgisini içerir.

Hata Kodları​

The following table lists the error codes that the API can return.

Error CodeMessageDescription
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.
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.
458Tarih aralığı hatalı.Gönderdiğiniz tarih formatı veya tarih aralığınız 10 günden daha fazla.