Skip to main content

XML Post API

Warning

This API method is under development, there may be changes to it. Please contact your customer representative to access the API method.

To retrieve the list of groups defined in your contact list using the POST method of the HTTP protocol in XML format, you can follow the instructions below.

Request URL​

POSThttps://api.iletimerkezi.com/v1/get-groups

Request Body​

<request>
  <authentication>
    <key></key>
    <hash></hash>
  </authentication>
</request>

Definitions​

The request sent to the server must be wrapped in 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.

Server Response​

<response>
  <status>
    <code></code>
    <message></message>
  </status>
  <groups>
    <group>
      <id></id>
      <name></name>
      <count></count>
      <children>
        <child>
          <id></id>
          <name></name>
          <count></count>
        </child>
      </children>
    </group>
  <groups>
</response>

Definitions​

The response from the server is always wrapped in 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.

groups​

If the operation is successfully completed, it contains the information of the main groups created in your contact list. If the operation fails, this tag is not returned. The sub-tags are as follows.

  • group​

    Contains information about the group. Repeats as many times as the number of main groups defined. The sub-tags are as follows.

    • id: The unique value representing the group.

    • name: Contains the name of the group.

    • count: Shows the number of people in the group.

    • children​

      Contains information about the sub-groups of the group, the sub-tags are as follows.

      • child​

        Contains information about the sub-group, repeats as many times as the number of sub-groups. The sub-tags are as follows.

        • id: The unique value representing the group.
        • name: Contains the name of the group.
        • count: Shows the number of people in the group.

Error Codes​

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

Error CodeMessageDescription
400İstek çözümlenemediPOST 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.
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.