MadelineProto/old_docs/API_docs_v72/methods/channels_leaveChannel.md

80 lines
1.8 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: channels.leaveChannel
description: channels.leaveChannel parameters, return type and example
---
## Method: channels.leaveChannel
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Optional|
2017-11-15 13:41:58 +01:00
### Return type: [Updates](../types/Updates.md)
### Can bots use this method: **YES**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|USER_CREATOR|You can't leave this channel, because you're its creator|
|USER_NOT_PARTICIPANT|You're not a member of this supergroup/channel|
|CHANNEL_PUBLIC_GROUP_NA|channel/supergroup not available|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-11-15 13:41:58 +01:00
if (isset($token)) { // Login as a bot
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-11-15 13:41:58 +01:00
$MadelineProto->complete_phone_login($code);
}
$Updates = $MadelineProto->channels->leaveChannel(['channel' => InputChannel, ]);
```
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 - channels.leaveChannel
* params - `{"channel": InputChannel, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.leaveChannel`
Parameters:
channel - Json encoded InputChannel
Or, if you're into Lua:
```
Updates = channels.leaveChannel({channel=InputChannel, })
```