Создание чата или канала
Метод позволяет создавать чат или канал, добавлять его описание и иконку, назначать администраторов, добавлять участников (для чата) или подписчиков (для канала).
HTTP метод: POST
URL: https://botapi.messenger.yandex.net/bot/v1/chats/create/
Заголовки
Authorization: OAuth <токен>
Content-Type: application/json
Тело запроса (JSON)
| Имя параметра | Обязательный | Тип | Описание | Ограничения, значение по умолчанию |
|---|---|---|---|---|
name |
Да | string |
Название чата (канала) | Не более 200 символов |
description |
Да | string |
Описание чата (канала) | Не более 500 символов, допустима пустая строка |
avatar_url |
Нет | string |
Иконка чата (канала) | URL изображения |
admins |
Нет | User[] |
Список администраторов чата (канала) | — |
members |
Нет | User[] |
Список участников чата | Список должен быть пустым, если создается канал вместо чата (channel=true) |
channel |
Нет | boolean |
Флаг для создания канала вместо чата | — |
subscribers |
Нет | User[] |
Список подписчиков канала | Список должен быть пустым, если создается чат (channel=false) |
Ограничения
- Бот может создавать чат (канал) только с участниками организации, которой он принадлежит.
- Все создаваемые чаты (каналы) принадлежат организации, которой принадлежит бот.
- Бот становится админстратором созданного чата (канала).
- Бот не может добавить в чат участника, для которого это запрещено настройками приватности.
Результат
Результатом успешного запроса является ответ с кодом 200 и телом с JSON, где содержится информация о созданном чате (канале).
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
chat_id |
Да | string |
ID созданного чата (канала) |
В случае ошибки возвращается соответствующий статус HTTP. Описание ошибки приходит в поле description.
| Имя параметра | Обязательный | Тип | Описание |
|---|---|---|---|
ok |
Да | boolean |
Флаг успешности выполнения |
description |
Да | string |
Описание ошибки |
Пример запроса
curl -H 'Authorization: OAuth AtXXXXXXXXXXX' -H "Content-Type: application/json" -d '{"name": "Поздравляем Аню", "description": "Чат в честь дня рождения","members": [{"login": "anya@example.org"}, {"login": "masha@example.org"}, {"login": "petya@example.org"}]}' 'https://botapi.messenger.yandex.net/bot/v1/chats/create/'
Пример успешного ответа
{"ok": true, "chat_id": "0/0/4f24b544-697c-4e18-a9c1-b39432ee9bf9"}
Пример ответа с ошибкой
{"ok": false, "description": "Creating chat with user restricted by privacy settings"}
Была ли статья полезна?
Предыдущая