Skip to main content

JSON Post API

This method is used to cancel an SMS package that has been created for a future date. You can use it by sending data in JSON format using the POST method of the HTTP protocol.

Tip

Orders that have already begun delivery cannot be canceled.

Request URL​

POSThttps://api.iletimerkezi.com/v1/cancel-order/json

Request Body​

{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "order": {
      "id": ""
    }
  }
}

Definitions​

The request made to the server must be wrapped with the request tag. The definitions of its sub-tags are as follows:

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.

order​

Contains information about the SMS order to be canceled. Its sub-tag is as follows:

  • id: A unique numeric value representing the order. This is the id value returned by the server when you make a request to send an SMS via the API. It is mandatory to send this value when making the request.

Server Response​

{
  "response": {
    "status": {
      "code": "200",
      "message": "Operation successful"
    }
  }
}

Definitions​

The response received from the server is always wrapped with the response tag. The definitions of its sub-tags are as follows:

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.

Error Codes​

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.
455Sipariş bulunamadıİstek içerisinde iletmiş olduğunuz id ile oluşturulmuş bir sipariş yoksa veya sipariş gönderimi bekliyor durumundan iletiliyor durumuna geçti ise bu hatayı alırsınız.

Example Request​

{
  "request": {
    "authentication": {
      "key": "507caf2e1fcdb5eea9786332ca2d8785",
      "hash": "0db4e316db72c519ba08121985f6ddf479809053d555c"
    },
    "order": {
      "id": "428"
    }
  }
}

Example Successful Response​

{
  "response": {
    "status": {
      "code": "200",
      "message": "Operation successful"
    }
  }
}

Example Error Response​

{
  "response": {
    "status": {
      "code": "400",
      "message": "Request could not be resolved"
    }
  }
}