XML 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 XML 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

Request Body

<request>
  <authentication>
    <key></key>
    <hash></hash>
  </authentication>
  <order>
    <id></id>
  </order>
</request>

Definitions

The request to the server must be wrapped in the request tag. The definitions of the sub-tags of this tag 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. The sub-tag is as follows:

• id: A unique numeric value representing the order. This is the id value returned to you by the server when you made the SMS sending request through the API. It is mandatory to send this during the request.

Server Response

<response>
  <status>
    <code>200</code>
    <message>Transaction successful</message>
  </status>
</response>

Definitions

The response from the server is always wrapped in the response tag. The definitions of the sub-tags of this tag 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 Code	Message	Description
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.
455	Sipariş 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

<?xml version="1.0" encoding="UTF-8" ?>
<request>
  <authentication>
    <key>demo</key>
    <hash>demo</hash>
  </authentication>
  <order>
    <id>428</id>
  </order>
</request>

Example Successful Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>200</code>
    <message>Transaction successful</message>
  </status>
</response>

Example Error Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>
    <code>400</code>
    <message>Request could not be resolved</message>
  </status>
</response>