Get API
If you want to send SMS with the GET method of the HTTP protocol, you can follow the instructions below. In general, you can integrate the settings in the SMS integration panels of ready-made software or hardware/devices such as firewall into the Ileti Merkezi with the help of the documentation here.
Address to request
GEThttps://api.iletimerkezi.com/v1/send-sms/get/Request Parameters
https://api.iletimerkezi.com/v1/send-sms/get/?username=USER_NAME&password=PASSWORD&text=Lorem%20ipsum%20dolor%20sit%20amet&receipents=5301234569,5301234570&sender=APITEST
After you write your own values in the request parameters, you can try the integration by typing the url address into the address field of your browser. If you get an error, you can see how the error can be resolved in the status and error codes section.
Definitions
The descriptions of the parameters sent in the request are as follows:
username: It is the user name used when logging into transmissionerkezi.com. It is usually the mobile phone number given at the registration stage. It is required to be sent when making a request.
password: This is the password used when logging into transmissionerkezi.com. It is required to be sent when making a request.
text: Contains the text of the SMS to be sent. It is required to be sent when making a request. The URL must be encoded.
If you are not integrating with a ready-made panel or if you are making a panel for sms integration into your own software, you should encode these values as your message text in the "text" field may contain characters that may corrupt the url address.
Every software language has built-in functions that do this encoding.
&text=Example of unencoded message text
After #encode, the message text should appear as follows
&text=Unencoded%20%C5%9F%20message%20text%20%C3%B6rne%C4%9Fi
receipts: Contains the recipient's mobile phone number. The number format should be 5xxxxxxxxx. If more than one recipient is to be defined for the specified message text, the numbers must be separated by commas. It is required to be sent when making a request.
sender: It is the header information, consisting of maximum 11 characters, defined from the transmissionerkezi.com administration panel and approved by transmissionerkezi.com. The sent message is sent to the receiver with the header specified with this parameter. It is required to be sent when making a request. The URL must be encoded.
Sample Request
https://api.iletimerkezi.com/v1/send-sms/get/?username=505333xxxx&password=XXXX&text=Lorem%20ipsum%20dolor%20sit%20amet&receipents=5301234569,5301234570&sender=APITEST
Server Response
<response>
<status>
<code></code>
<message></message>
</status>
<order>
<id></id>
</order>
</response>
Definitions
The response from the server is always wrapped in the response tag. The definition of this tag, its subtags, 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.
order
Contains the order information created if the transaction was completed successfully. If the operation fails, this tag is not returned. The order tag is not a repeatable tag. Only one order can be submitted per request. The alt tag is as follows:
- id: Unique numeric value representing the order. By storing the "id" value in your own systems, you can use it when querying the report of the order, and when canceling the order if you have made a post-dated delivery.
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.
| code | message | Description |
|---|---|---|
| 401 | Incorrect membership information | username, password tag, we give this error when we cannot verify the information you have sent, if you have defined a fixed IP in your account and you are requesting from a different IP, you will get this error again. |
| 402 | Insufficient balance | If the balance in your account is not enough to send this order, we give this error. |
| 450 | sent bnot suitable for use | If the value you sent with the sender tag is not approved in your account, you will get this error, you need to send it as defined in your account. Usually, the changes that cause this error are lowercase and uppercase letters or sending extra space values. |
| 451 | Repeating order | If you want to resend the same message text to the same recipients within 10 minutes, the system will return this error to you, so that there is no spam and the same messages are not sent to the same people by mistake. If you need such a transmission, you can differentiate the text of the message by typing the current hour and minute in the message text. |
| 452 | Message recipients are incorrect | If the phone numbers you sent with the receipents tag are missing or cannot be verified, we give this error. At the same time, if you are sure that the mobile phone number you want to message is correct, you can still get this error if you have added the mobile phone number to your number blocking list. |
| 453 | Order size exceeded | If the text of the message you sent with the text tag is more than seven (7) SMS lengths according to your character encoding, this error will return. |
| 454 | Message text is empty | If the text of the message you sent in the text parameter does not contain any value, your message will not be sent and this error message will be returned. |
Example Successful Response
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<code>200</code>
<message>Operation Successful</message>
</status>
<order>
<id>323223</id>
</order>
</response>
Example Incorrect Answer
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>
<code>401</code>
<message>Membership information is incorrect</message>
</status>
</response>