MadelineProto/docs/API_docs/methods/ping.md
Daniil Gentili d69a27867f Better docs
2017-08-28 12:44:50 +02:00

72 lines
1.2 KiB
Markdown

---
title: ping
description: ping parameters, return type and example
---
## Method: ping
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|ping\_id|[long](../types/long.md) | Yes|
### Return type: [Pong](../types/Pong.md)
### Can bots use this method: **YES**
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$Pong = $MadelineProto->ping(['ping_id' => long, ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### 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:
```
Pong = ping({ping_id=long, })
```