Version No 3.2.0

Sending SMS via GET

---

Learn how to send a message through the API using the GET format. Sending messages via GET is a straightforward and simple process.

Variables and options are appended to the link, just like the examples mentioned above. The link structure is as follows:

								
api/v3/get/get.php?api_key=API_KEY_HERE&mobile=MOBILE_HERE&title=TITLE_HERE&text=SMS_TEXT_HERE&report=1&lang=2&response_type=json&content_type=0
								
							

In a GET request, data is sent in the URL itself, making it visible and easy to understand. The parameters are appended to the URL after a question mark (`?`), and each parameter-value pair is separated by an ampersand (`&`). This simplicity makes it convenient for testing and quick integration.

It's important to note that due to the visibility of data in the URL, sensitive information should not be passed through GET requests for security reasons. For sensitive data, it's recommended to use the POST method.

Send Options

---

Send options represent characteristics of a message sent through an API, such as the language of the message content or the appearance of a report.

Sending OTP SMS

---

The OTP service, short for "One Time Passcode," generates a randomly created code for one-time use. This code is sent via SMS and is utilized in verification processes, login procedures, and account confirmations. OTP is often used in two-factor authentication to enhance security for your login processes. One key feature of OTP is that the password is usable for only one time, providing added security against hacking and password guessing attempts.

The direct API link for sending SMS OTP via [GET] is:

The variables sent through the link are:

								
$api_key  = '';
$mobile   = '';
$digits   = '';
$report   = '';
$lang     = '';
$response_type = '';
								
							

Explanation of the variables sent through the link:

api_key$	varchar	Your API key placed here.
mobile$	int	The recipient's number. It should not contain letters or symbols.
digits$	int	The number of digits in the verification code.
report$	int	Option to display the delivery report. 1 for display, 0 to cancel.
lang$	int	Language option for the sent message. 2 for Arabic, 0 for English.
response_type$	int	Option to display the server response in a specific programming language.

After the sending process, the server will respond with the following:

Example response from the server after the sending process:

								
Array
(
	[result] => true
	[otp_code] => 123456
	[sms_id] => 1000007721
	[number_of_sms] => 1
	[result_code] => TS-1024
	[result_message] => The message was sent successfully
	[sms_lang] => Arabic
	[country] => Turkey-TR
)
								
							

Explanation of the variables sent from the server:

result	The result of the process. "true" indicates success, "false" indicates failure.
otp_code	The verification code sent in the message to the recipient.
sms_id	The recorded ID of the process, which allows tracking the message's status.
number_of_sms	The number of messages or credits deducted from your account after sending the message.
result_code	The process code. Refer to the sending codes section for complete details.
result_message	The message from the sent process. It displays a message about the success or failure of the process.
sms_lang	The language of the sent message.
country	The name of the country to which the message was sent.

Response Codes

---

When sending a message via the direct API connection, the server will respond with a code to indicate the outcome of the process. These codes provide information about the result of the operation you have performed.

Checking SMS Status

---

Verification of authorization code could be made by POST request to API with two parameters, recipient mobile phone number

								
turkeysms.com.tr/api/v3/sms-durumu/sms_durumu.php?api_key=API_KEY_HERE&sms_id=SMS_ID_HERE&response_type=php
								
							

The variables sent through the link are

								
$api_key  = '';
$sms_id	  = '';
$response_type = '';
								
							

Parameter Description

api_key$	varchar	Your API key on your account will be placed here
sms_id$	int	Message ID
response_type$	int	Response is sending JSON or PHP

Call Back Reports

Example Response

								
Array
(
	[result] => true
	[sender_id] => SenderID
	[date_of_sending] => 2021-01-01
	[time_of_sending] => 13:10:00
	[sms_status] => Number received the message
	[sms_status_code] => TS-1024
	[sms_balance] => 1 SMS
	[operator] => Turkcell
)
								
							

Parameter Description

result	The result of the operation, if successful, appears true, and if the transmission fails, it appears false
sender_id	Message ID. Length of this parameter in each request may vary
date_of_sending	The date the message was sent
time_of_sending	The time the message was sent
sms_status	Message Status - Delivered - Not delivered - Number out of coverage
sms_status_code	Status Code
sms_balance	Number of used credits
operator	The name of the company to which the number belongs

Check Balance [POST]

---

You can inquire about the available balance in your account, both local and international.

				
turkeysms.com.tr/api/v3/bakiye_sorgulama/add-content
				
							

Variables sent for the inquiry:

				
$api_key  = '';
$response_type = '';
				
							

Explanation of the variables sent through the link:

api_key$	varchar	Your API key placed here.
response_type$	int	Option to display the server response in a specific programming language.

After the inquiry process, the server will respond with the following:

Example response from the server:

Array
(
	[result] => true
	[result_code] => TS-1040
	[result_message] => operation_success
	[api_key] => api_key
	[local_balance_sms] => 1
	[international_balance_tl] => 1
)
				

Explanation of the variables sent from the server:

result	The result of the process. "true" indicates success, "false" indicates failure.
result_code	The process code.
result_message	The content of the operation message.
api_key	Here appears the connection key for the account.
local_balance_sms	Local balance - Inside Turkey, displayed as the number of messages.
international_balance_tl	International balance - Displayed as a financial value in Turkish Lira.

International SMS

---

The term "international messages" refers to messages sent outside the borders of the Turkish Republic.
These messages include all numbers that do not start with the international code (+90-0090).
Turkey SMS service enables you to send SMS messages through your account to any country in the world. However, you need to charge your balance with an international account to send messages to any country.
The price of the message varies from one country to another, and the delivery time of the international message also varies. To send internationally, you must contact the Technical Support Center of Turkey SMS service to activate your account.

How do I send an international message through the API?

Example

---

The text messaging system supports various programming languages for seamless integration. Below are examples for different programming languages:

PHP Java JavaScript NodeJS Python CSharp C(LibCURL) Go ObjectiveC Ruby Swift

PHP

function sendRequest($site, $data)
{
    $json = json_encode($data);
    $ch = curl_init($site);
    $header = array('Content-Type: application/json');
    curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $json);
    $result = curl_exec($ch);
    curl_close($ch);
    return $result;
}
$api_key  = '';
$title    = '';
$text	  = '';
$sentto	  = '';

$body = array("api_key" => $api_key, "title"=>$title, "text"=>$text,"sentto"=>$sentto);
$result = sendRequest('turkeysms.com.tr/api/v3/gonder/add-content', $body);
//http://www.lalit.org/lab/convert-xml-to-array-in-php-xml2array/

JAVA

Unirest.setTimeouts(0, 0);
HttpResponse response = Unirest.post("turkeysms.com.tr/api/v3/gonder/add-content")
.header("Content-Type", "application/json")
.body("{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}")
.asString();

JavaScript

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");

var raw = JSON.stringify({"api_key":"API_KEY_HERE","title":"SMS_TITLE_HERE","text":"TEXT_SMS","sentto":"90500000000"});

var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};

fetch("turkeysms.com.tr/api/v3/gonder/add-content", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));

Python

import requests

url = "turkeysms.com.tr/api/v3/gonder/add-content"

payload = "{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}"
headers = {
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

Ruby

require "uri"
require "net/http"

url = URI("turkeysms.com.tr/api/v3/gonder/add-content")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request.body = "{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}"

response = https.request(request)
puts response.read_body

CSharp

var client = new RestClient("turkeysms.com.tr/api/v3/gonder/add-content");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

C(LibCURL)

CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
  curl_easy_setopt(curl, CURLOPT_URL, "turkeysms.com.tr/api/v3/gonder/add-content");
  curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
  struct curl_slist *headers = NULL;
  headers = curl_slist_append(headers, "Content-Type: application/json");
  curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
  const char *data = "{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}";
  curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
  res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);

NodeJS

var unirest = require('unirest');
var req = unirest('POST', 'turkeysms.com.tr/api/v3/gonder/add-content')
  .headers({
    'Content-Type': 'application/json'
  })
  .send(JSON.stringify({"api_key":"API_KEY_HERE","title":"SMS_TITLE_HERE","text":"TEXT_SMS","sentto":"90500000000"}))
  .end(function (res) { 
    if (res.error) throw new Error(res.error); 
    console.log(res.raw_body);
  });

ObjectiveC

#import  Foundation/Foundation.h>

dispatch_semaphore_t sema = dispatch_semaphore_create(0);

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"turkeysms.com.tr/api/v3/gonder/add-content"]
  cachePolicy:NSURLRequestUseProtocolCachePolicy
  timeoutInterval:10.0];
NSDictionary *headers = @{
  @"Content-Type": @"application/json"
};

[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];

[request setHTTPMethod:@"POST"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
  if (error) {
    NSLog(@"%@", error);
  } else {
    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
    NSError *parseError = nil;
    NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
    NSLog(@"%@",responseDictionary);
    dispatch_semaphore_signal(sema);
  }
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);

Go

package main
import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)
func main() {
  url := ""turkeysms.com.tr/api/v3/gonder/add-content"
  method := "POST"
  payload := strings.NewReader("{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}")
  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  defer res.Body.Close()
  body, err := ioutil.ReadAll(res.Body)

  fmt.Println(string(body))
}

Swift

import Foundation

var semaphore = DispatchSemaphore (value: 0)

let parameters = "{\"api_key\":\"API_KEY_HERE\",\"title\":\"SMS_TITLE_HERE\",\"text\":\"TEXT_SMS\",\"sentto\":\"90500000000\"}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "turkeysms.com.tr/api/v3/gonder/add-content")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
  semaphore.signal()
}

task.resume()
semaphore.wait()

SMS Libraries

---

You can download ready-made files in the programming language you want for your use

PHP File