Просмотров: 10971
Дата последнего изменения: 28.07.2022
Сложность урока:
3 уровень - средняя сложность. Необходимо внимание и немного подумать.
4
5
Создание чата |
Ревизия
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get
: 18 |
Обратите внимание! Метод указан с использованием функции
restCommand - это метод отправки данных в
Битрикс24, данный метод есть в примере
ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод
BX24.callMethod или
bitrix24-php-sdk.
Параметры
Параметр |
Пример |
Обязат. |
Описание |
Ревизия |
TYPE |
CHAT |
Нет |
Тип чата OPEN | CHAT (OPEN - открытый для вступления чат, CHAT - обычный чат по приглашениям, по-умолчанию CHAT) |
18 |
TITLE |
Мой новый закрытый чат |
Нет |
Заголовок чата |
18 |
DESCRIPTION |
Очень важный чат |
Нет |
Описание чата |
18 |
COLOR |
PINK |
Нет |
Цвет чата для мобильного приложения: RED, GREEN, MINT, LIGHT_BLUE, DARK_BLUE, PURPLE, AQUA, PINK, LIME, BROWN, AZURE, KHAKI, SAND, MARENGO, GRAY, GRAPHITE |
18 |
MESSAGE |
Добро пожаловать в чат |
Нет |
Первое приветственное сообщение в чате |
18 |
USERS |
Array(1,2) |
Да |
Участники чата |
18 |
AVATAR |
base64 image |
Нет |
Аватар чата в base64 формате |
18 |
ENTITY_TYPE |
CHAT |
Нет |
Идентификатор сущности, может быть использован для поиска по этому полю и для легкого определения контекста в обработчиках событий ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE |
18 |
ENTITY_ID |
13 |
Нет |
Числовой идентификатор сущности, может быть использован для поиска чата и для легкого определения контекста в обработчиках событий ONIMBOTMESSAGEADD, ONIMBOTMESSAGEUPDATE, ONIMBOTMESSAGEDELETE |
18 |
OWNER_ID |
39 |
Нет |
Идентификатор владельца чата. Можно не указывать, если вы создаете чат под нужным пользователем |
18 |
|
Вызов метода и ответ
PHP
$result = restCommand('im.chat.add', Array(
'TYPE' => 'CHAT',
'TITLE' => 'Мой новый закрытый чат',
'DESCRIPTION' => 'Очень важный чат',
'COLOR' => 'PINK',
'MESSAGE' => 'Добро пожаловать в чат',
'USERS' => Array(1,2),
'AVATAR' => 'base64 image',
'ENTITY_TYPE' => 'CHAT',
'ENTITY_ID' => 13,
'OWNER_ID' => 39,
), $_REQUEST["auth"]);
Пример ответа
{
"result": 123
}
Пример ответа при возникновении ошибки
{
"error": "USERS_EMPTY",
"error_description": "Не переданы участники чата"
}
Описание ключей:
error
– код возникшей ошибки
error_description
– краткое описание возникшей ошибки
Возможные коды ошибок
Код |
Описание |
USERS_EMPTY |
Не переданы участники чата |
WRONG_REQUEST |
Что-то пошло не так |
|