im-disk-folder-get.md

Get Chat File Storage Folder im.disk.folder.get

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: im

Who can execute the method: chat participant

{% note warning "Deprecated method" %}

The method is kept to support existing integrations. To upload a file to a chat, the folder is no longer needed — use im.v2.File.upload.

{% endnote %}

The method im.disk.folder.get retrieves the identifier of the folder where chat files are stored.

The identifier from the response can be used in Drive methods:

• disk.folder.uploadfile to upload a file to the chat folder
• disk.folder.getchildren to get a list of files in the folder

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || CHAT_ID* integer | Identifier of the chat. Required if DIALOG_ID is not provided || || DIALOG_ID* string | Identifier of the dialog in the format chatXXX, where XXX is the identifier. Required if CHAT_ID is not provided || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"DIALOG_ID":"chat1489"}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.disk.folder.get

• cURL (OAuth)

  curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"DIALOG_ID":"chat1489","auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/im.disk.folder.get

• JS (TS)

  // This snippet is an ES module: top-level await requires type="module" or a bundler.
  // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
  import { Text } from '@bitrix24/b24jssdk'
  import type { B24Frame } from '@bitrix24/b24jssdk'
  
  declare const $b24: B24Frame
  
  // Shape of the payload returned in result (match the "response handling" section of the page)
  type DiskFolderGetResult = {
    ID: number
  }
  
  try {
    const response = await $b24.actions.v2.call.make<DiskFolderGetResult>({
      method: 'im.disk.folder.get',
      params: {
        DIALOG_ID: 'chat1489',
      },
      requestId: Text.getUuidRfc4122()
    })
  
    // The payload is available only on a successful response
    if (!response.isSuccess) {
      console.error(response.getErrorMessages().join('; '))
    } else {
      const result = response.getData()!.result
      console.info(result.ID)
    }
  } catch (error) {
    // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
    console.error(error)
  }

• JS (UMD)

  <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
  <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
  <script>
    async function getDiskFolder() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'im.disk.folder.get',
          params: {
            DIALOG_ID: 'chat1489',
          },
          requestId: B24Js.Text.getUuidRfc4122()
        })
  
        // The payload is available only on a successful response
        if (!response.isSuccess) {
          console.error(response.getErrorMessages().join('; '))
          return
        }
  
        const result = response.getData().result
        console.info(result.ID)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', getDiskFolder)
  </script>

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'im.disk.folder.get',
              [
                  'DIALOG_ID' => 'chat1489',
              ]
          );
  
      $result = $response
          ->getResponseData()
          ->getResult();
  
      echo 'Success: ' . print_r($result, true);
  } catch (Throwable $e) {
      error_log($e->getMessage());
      echo 'Error: ' . $e->getMessage();
  }

• BX24.js

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

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'im.disk.folder.get',
      [
          'DIALOG_ID' => 'chat1489',
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "im.disk.folder.get", b24.Params{
  	"DIALOG_ID": "chat1489",
  }, b24.WithIdempotent())
  if err != nil {
  	return fmt.Errorf("im.disk.folder.get: %w", err)
  }
  
  var item struct {
  	ID b24.ID `json:"ID"`
  }
  if err := json.Unmarshal(res.Result, &item); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  fmt.Println(item.ID)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": {
        "ID": 5153
    },
    "time": {
        "start": 1772192121,
        "finish": 1772192121.447936,
        "duration": 0.4479360580444336,
        "processing": 0,
        "date_start": "2026-02-27T14:35:21+02:00",
        "date_finish": "2026-02-27T14:35:21+02:00",
        "operating_reset_at": 1772192721,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | Root element of the response || || result.ID integer | Identifier of the chat file storage folder || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

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

{% include notitle error handling %}

Possible Error Codes

#| || Status | Code | Description | Value || || 400 | CHAT_ID_EMPTY | Chat ID can't be empty | Possible reasons:

• one of the required parameters is missing: CHAT_ID or DIALOG_ID
• an empty CHAT_ID was provided || || 400 | DIALOG_ID_EMPTY | Dialog ID can't be empty | An invalid or empty DIALOG_ID was provided || || 403 | ACCESS_ERROR | You do not have access to the specified dialog | Insufficient permissions to view the dialog or a non-existent dialog was provided || |#

{% include system errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}