Ping (تست ارتباط)

معرفی

با استفاده از این API می‌توانید با یک درخواست ساده و بدون پارامتر ورودی ارتباط نرم افزار خود با سیموتل را تست کنید. به این صورت که بک درخواست Ping به سرور سیموتل ارسال می‌کنید و در صورتی که همه چیز مرتب باشد از سرور پاسخ Success دریافت خواهید کرد.

پیاده سازی

پارامترها

این API هیچ پارامتر ورودی ندارد.

نمونه فراخوانی

نمونه کد استفاده
نمونه خروجی

PHP
JS
Curl

نمایش کامل کد PHP

	<?php

	$curl = curl_init();

	curl_setopt_array($curl, array(
	  CURLOPT_URL => 'http://192.168.51.20/api/v4/setting/ping/act',
	  CURLOPT_RETURNTRANSFER => true,
	  CURLOPT_ENCODING => '',
	  CURLOPT_MAXREDIRS => 10,
	  CURLOPT_TIMEOUT => 0,
	  CURLOPT_FOLLOWLOCATION => true,
	  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	  CURLOPT_CUSTOMREQUEST => 'POST',
	  CURLOPT_POSTFIELDS =>{},
	  CURLOPT_HTTPHEADER => array(
		'X-APIKEY: vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG',
		'Authorization: Basic dGVzdDpBYTEyMzQ1Ng==',
		'Content-Type: application/json'
	  ),
	));

	$response = curl_exec($curl);

		if (!curl_errno($curl)) {
		$httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
		echo 'response code:'.$httpcode, '<br/>';
	}

	curl_close($curl);
	echo $response;
?>

نمایش کامل کد JS

	<html>
			<head>
				<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
			</head>
		<body>
			<script>
				var settings = {
				  "url": "http://192.168.51.20/api/v4/setting/ping/act",
				  "method": "PUT",
				  "timeout": 0,
				  "headers": {
					"X-APIKEY": "vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG",
					"Authorization": "Basic dGVzdDpBYTEyMzQ1Ng==",
					"Content-Type": "application/json"
				  },
				  "data": JSON.stringify({}),
				};


					$.ajax(settings).always(function (jqXHR) {
						console.log("response code: " + jqXHR.status + " " + jqXHR.statusText);
						console.log("response body: " + jqXHR.responseText);
					});
			</script>
		</body>
	</html>

نمایش کامل کد Curl

	curl --location --request PUT 'http://192.168.51.20/api/v4/setting/ping/act' \
	--header 'X-APIKEY: vZKtIKWsld0egNlkzHo8i5LVBqLNBSWARCQsPOSgDjFmAHM3tG' \
	--header 'Authorization: Basic dGVzdDpBYTEyMzQ1Ng==' \
	--header 'Content-Type: application/json' \
	--data-raw ''

{
"success":1,
"message":"If the 'Ping' event is enabled in the settings menu, you'll receive it when it's sent",
"data":null
}

رخداد Ping

در صورتی که رخداد Ping در تنظیمات سیموتل فعال باشد، بعد از فراخوانی API پینگ وب هوک فعال می‌شود.

معرفی​

پیاده سازی​

پارامترها​

نمونه فراخوانی​

نمونه فراخوانی​

رخداد Ping​

معرفی

پیاده سازی

پارامترها

نمونه فراخوانی

نمونه فراخوانی

رخداد Ping