Views: 1064 (Data available since 06.02.2017)

The method gets information on folder storing files for chat

Revision: 18
Get information on the current API revision (platform version) – im.revision.get.

Parameters

Parameter Example Req. Description Revision
CHAT_ID 17 Yes Chat ID 18

Method call

JavaScript

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

PHP

$result = restCommand('im.disk.folder.get', Array(
	'CHAT_ID' => 17,
), $_REQUEST["auth"]);

Example of response

{
	"result": {
		ID: 127
	}
}

Example of response when error occurs

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

Description of keys:

  • error – error code
  • error_description – brief description of error

Possible error codes

Code Description
CHAT_ID_EMPTY Chat ID not passed
ACCESS_ERROR Current user does not have appropriate permissions to access the dialog
INTERNAL_ERROR Server error, please contact technical support

Attention! The method is specified with using of the restCommand function. This method is used to send data in Bitrix24 and is available in the EchoBot example as well as in this article. You can use your own function or BX24.callMethod, or bitrix24-php-sdk JavaScript methods.





Courses developed by «Bitrix», Inc.
Course description


Upstairs ↑