MadelineProtoDocs/old_docs/API_docs_v72/methods/ping.md

69 lines
1.2 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: ping
2018-12-26 02:56:50 +01:00
description: Pings the server
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: ping
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2018-12-26 02:56:50 +01:00
Pings the server
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|ping\_id|[long](../types/long.md) | Ping ID | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Pong](../types/Pong.md)
### Can bots use this method: **YES**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Pong = $MadelineProto->ping(['ping_id' => long, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - ping
* params - `{"ping_id": long, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/ping`
Parameters:
ping_id - Json encoded long
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
Pong = ping({ping_id=long, })
```