MadelineProto/old_docs/API_docs_v23/methods/messages_addChatUser.md

80 lines
2.3 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.addChatUser
2018-03-23 12:35:00 +01:00
description: Add a user to a normal chat (use channels->inviteToChannel for supergroups)
---
2017-01-19 23:02:27 +01:00
## Method: messages.addChatUser
[Back to methods index](index.md)
2018-03-23 12:35:00 +01:00
Add a user to a normal chat (use channels->inviteToChannel for supergroups)
### Parameters:
2018-03-23 12:35:00 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to invite users|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to invite|
2018-03-27 14:41:50 +02:00
|fwd\_limit|[int](../types/int.md) | Yes|Number of old messages the user will see|
### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
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();
$messages_StatedMessage = $MadelineProto->messages->addChatUser(['chat_id' => InputPeer, 'user_id' => InputUser, 'fwd_limit' => int, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.addChatUser`
Parameters:
chat_id - Json encoded InputPeer
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
user_id - Json encoded InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
fwd_limit - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
messages_StatedMessage = messages.addChatUser({chat_id=InputPeer, user_id=InputUser, fwd_limit=int, })
```
2018-03-27 14:41:50 +02:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|CHAT_ID_INVALID|The provided chat id is invalid|
|INPUT_USER_DEACTIVATED|The specified user was deleted|
|PEER_ID_INVALID|The provided peer id is invalid|
|USER_ALREADY_PARTICIPANT|The user is already in the group|
|USER_ID_INVALID|The provided user ID is invalid|
|USERS_TOO_MUCH|The maximum number of users has been exceeded (to create a chat, for example)|
|USER_NOT_MUTUAL_CONTACT|The provided user is not a mutual contact|
|USER_PRIVACY_RESTRICTED|The user's privacy settings do not allow you to do this|