Для разработчиков

Новый чат

POST/chats

Создаёт беседу или канал. Владелец токена становится владельцем чата, и роль эта в дальнейшем не передаётся.

Мульти-гость, как и в интерфейсе, создавать чаты не может: метод отвечает ему 403.

Для создания личной переписки 1 на 1 с пользователем пользуйтесь методом POSTНовое сообщение. Чтобы обсудить конкретное сообщение, чат заводить не нужно — под ним заводят тред методом POSTНовый тред. Разговору на одну тему постоянное место тоже не нужно: для него есть метод POSTНовый самостоятельный тред.

Участников можно передать сразу: member_ids добавляет поимённо, group_tag_ids приводит всех, кто состоит в теге, и дальше поддерживает состав сам. Идентификаторы, которых в пространстве нет, а также приостановленные и удалённые сотрудники запрос не останавливают: чат создаётся с остальными участниками, а такие идентификаторы приходят в meta.not_found_member_ids. Несуществующие теги пропускаются молча. С ботами строже: если настройка бота «Кто может добавлять бота в чаты» не разрешает вам его добавить, чат не создаётся, а метод отвечает 403 с кодом bot_add_denied и идентификаторами таких ботов в value. Бот с настройкой «Ограничить одним чатом», который уже состоит в другой беседе или канале, тоже останавливает запрос, если он есть в member_ids или создаёт чат сам: чат не создаётся, а метод отвечает 409 с кодом single_chat_bot_occupied и идентификаторами таких ботов в value.

Аватар чату ставят после создания методом PUTЗагрузка аватара чата.

Тело запроса

application/json
chat
object
*
Собранный объект параметров создаваемого чата
name
string
*
Название. Пустое название заменяется именем и фамилией владельца токена (у бота — его именем), а если их нет — никнеймом.
Пример:🤿 aqua
Длина:
<= 255 символов
member_ids[]
array of integers, (int32)
Массив идентификаторов пользователей, которые станут участниками
Пример:[186,187]
group_tag_ids[]
array of integers, (int32)
Массив идентификаторов тегов, которые станут участниками
Пример:[86,18]
channel
boolean
Является каналом
Пример:true
По умолчанию:
false
public
boolean
Открытый доступ
Пример:false
По умолчанию:
false

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
data
object
*
Чат
id
integer, (int32)
*
Идентификатор созданного чата
Пример:334
name
string
*
Название
Пример:🤿 aqua
Длина:
<= 255 символов
created_at
string, (date-time)
*
Дата и время создания чата (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
owner_id
integer, (int32)
*
Идентификатор пользователя, создавшего чат
Пример:185
member_ids[]
array of integers, (int32)
*
Массив идентификаторов пользователей, участников
Пример:[185,186,187]
group_tag_ids[]
array of integers, (int32)
*
Массив идентификаторов тегов, участников
Пример:[9111]
channel
boolean
*
Является каналом
Пример:true
archived
boolean
*
Находится в архиве
Пример:false
personal
boolean
*
Является личным чатом
Пример:false
public
boolean
*
Открытый доступ
Пример:false
last_message_at
string, (date-time)
*
Дата и время создания последнего сообщения в чате (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2021-08-28T15:56:53.000Z
meet_room_url
string
*
Ссылка на Видеочат
Пример:https://meet.pachca.com/aqua-94bb21b5
avatar_url
nullablestring
*
Ссылка на аватар чата. null, если аватар не задан.
Пример:https://files.example.com/uploads/0001/0001/image.jpg
meta
object
*
Метаданные ответа
not_found_member_ids[]
array of integers, (int32)
*
Идентификаторы из member_ids, которые не удалось добавить: такого сотрудника нет в пространстве, он приостановлен или удалён. Пустой массив, если добавлены все.
Пример:[]
Новый чат
pachca chats create \  --name='🤿 aqua' \  --member-ids='[186,187]' \  --group-tag-ids='[86,18]' \  --channel \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 201
{  "data": {    "id": 334,    "name": "🤿 aqua",    "created_at": "2021-08-28T15:56:53.000Z",    "owner_id": 185,    "member_ids": [      185,      186,      187    ],    "group_tag_ids": [      9111    ],    "channel": true,    "archived": false,    "personal": false,    "public": false,    "last_message_at": "2021-08-28T15:56:53.000Z",    "meet_room_url": "https://meet.pachca.com/aqua-94bb21b5",    "avatar_url": "https://files.example.com/uploads/0001/0001/image.jpg"  },  "meta": {    "not_found_member_ids": []  }}