60  /  108

im.disk.file.commit

Просмотров: 406 (Статистика ведётся с 06.02.2017)
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

Публикация загруженного файла в чат

Ревизия: 18
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get.

Параметры

Параметр Пример Обязат. Описание Ревизия
CHAT_ID 17 Да Идентификатор чата 18
UPLOAD_ID 213 Да* Идентификатор загруженного файла через методы модуля DISK 18
DISK_ID 112 Да* Идентификатор файла, доступного из локального диска 18
MESSAGE Важный документ Нет Описание файла будет опубликовано в чате 18
SILENT_MODE N Нет Параметр для чата Открытых линий, обозначает, будет ли отправлена информация о файле клиенту или нет 18
  • Для успешного вызова API нужно указать CHAT_ID и одно из двух полей – UPLOAD_ID или DISK_ID.

Обратите внимание! Файл должен быть предварительно загружен через метод disk.folder.uploadfile.


Вызов метода

JavaScript

BX24.callMethod('im.disk.file.commit', {
	'CHAT_ID': 17,
	'UPLOAD_ID': 112,
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('im.disk.file.commit', Array(
	'CHAT_ID' => 17,
	'UPLOAD_ID' => 112,
), $_REQUEST["auth"]);

Пример ответа

{
	"result": true
} 

Пример ответа при возникновения ошибки

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID can't be empty"
}

Описание ключей:

  • error – код возникшей ошибки
  • error_description – краткое описание возникшей ошибки

Возможные коды ошибок

Код Описание
CHAT_ID_EMPTY Не передан идентификатор чата
ACCESS_ERROR Текущий пользователь не имеет прав доступа к диалогу
FILES_ERROR Не переданы идентификатор файлов

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.



0
Курсы разработаны в компании «1С-Битрикс»