Skip to main content

JSON 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.

You can follow the instructions below to search your contacts in JSON format using the POST method of the HTTP protocol.

Address to request​

POSThttps://api.iletimerkezi.com/v1/search-contacts/json

Request Content (Body)​

Content of the request if you are processing using API Key
{
  "request": {
    "authentication": {
      "key": "",
      "hash": ""
    },
    "search": {
      "key": "",
      "page": [],
      "rowCount": []
    }
  }
}

Definitions​

The request to the server must be wrapped with the request tag. The definitions of the subtags of this tag are as follows:

authentication​

It is the user information that must be sent in order to receive authorization for the requested operation. The alt tags are as follows:

  • key: API Key that you can create from the settings section should be written in this field after logging in to your iletimerkezi.com panel. It is required to be sent when making a request.

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

Contains search criteria. It doesn't repeat. The alt tags are as follows.

  • key: Shows the value to be searched, searches within the phone number, name, surname and email addresses fields in your directory.
  • page: Represents the search result page. It is not required to be sent when making a request. Its default value is 1.
  • rowCount: Indicates the number of people on a search results page. It is not required to be sent when making a request. Its default value is 1000. Its maximum value is 1000. If there are more than 1000 people, other search results pages should be queried with a separate request.

Server response​

{
  "response": {
    "status": {
      "code": "",
      "message": ""
    },
    "contacts": {
      "contact": [
        {
          "id": "",
          "name": "",
          "surname": "",
          "email": "",
          "gsm": "",
          "custom_fields": {
            "custom_field": [
              {
                "id": "",
                "value": ""
              }
            ]
          },
          "groups": {
            "group": [
              {"ID":""}
            ]
          }
        }
      ]
    }
  }
}

Definitions​

The response from the server is always wrapped in the response tag. The definition of subtags of this tag is as follows:

status​

Contains information about the transaction status. The values ​​returned by this tag can also be obtained by looking at the header information of the HTTP response. This tag is returned by default on every request made. The alt tags are as follows

  • code: It is the numerical value that indicates the operation status.
  • message: Contains an informational message about the transaction status.

contacts​

Contains information about the people in the group. The alt tags are as follows.

  • contact​

    Contains contact information. It repeats as many times as the number of people. The alt tags are as follows.

    • id: Indicates the unique numeric value that represents the person.

    • name: Indicates the name of the person.

    • surname: Indicates the surname of the person.

    • email: Represents the email address of the person.

    • gsm: refers to the person's mobile phone information.

    • custom_fields​

      It refers to the directory fields defined for the person. The alt tags are as follows.

      • custom_field​

        Indicates the directory area defined for the person. It repeats as many times as the defined area. The alt tags are as follows.

        • id: Unique numeric value representing the directory fields.
          • value: Indicates the value held for the contact in the Contacts field.
          • custom_field_settings: Indicates the value held for the contact in the Contacts field.

      • groups​

        Contains groups that the person belongs to. The alt tags are as follows.

        • group: Contains the information of the group the person belongs to. It repeats as many times as the group it is included in.
          • id: Unique numeric value representing the group.