Skip to main content

JSON Post API

You can follow the instructions below to get the list of blocked mobile phone numbers in JSON format using the POST method of the HTTP protocol.

Address to request

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

Request Content (Body)

Content of the request if you are processing using API Key
{
"request": {
"authentication": {
"key": "",
"hash": ""
},
"blacklist": {
"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.

blacklist

Label containing the number to add to the list.

  • 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. Required when requesting is not. Its default value is 1000. Its maximum value is 1000. If more than 1000 If there is a person, other search result pages should be queried with a separate request.

Server response

{
"response": {
"status": {
"code": "",
"message": ""
},
"blacklist": {
"count": "",
"number": []
}
}
}

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.

blacklist

Indicates the blocked number list. The alt tags are as follows.

  • count: Indicates the total number of blocked contacts.
  • number: Contains blocked number information.

Error Codes

If the result of the request is negative, the error codes and messages that will be returned to you by the server are as follows.

codemessageDescription
400The request could not be resolved is caused by an error in the structure of the XML you POST. These errors are usually caused by a misspelled XML tag, an improperly closed XML tag, or the use of a character that can break the structure of XML without using CDATA.
401Incorrect membership informationWe give this error when we can't verify the information you have submitted in the authentication tag of the XML you POST. If you have defined a fixed IP in your account and you are requesting from a different IP, you will get this error again.
404API does not have requested methodIf you're getting this error, double-check the address you requested, you may be making a request to a wrong address.

Sample Request

{
"request": {
"authentication": {
"key": "",
"hash":""
},
"blacklist": {
"page": 1,
"rowCount": 5
}
}
}

Example Successful Response

{
"response": {
"status": {
"code": 200,
"message": "Operation successful"
},
"blacklist": {
"count": "7906",
"number": [
"+905050047824",
"+905050047824",
"+905050047824",
"+905050047824",
"+905050047824"
]
}
}
}

Example Incorrect Answer

{
"response": {
"status": {
"code": 401,
"message": "Membership information is incorrect"
}
}
}