Skip to content

disk-folder-get-external-link.md

Latest commit

 

History

History
298 lines (238 loc) · 7.9 KB

disk-folder-get-external-link.md

File metadata and controls

298 lines (238 loc) · 7.9 KB
Raw

Get Public Link for Folder disk.folder.getExternalLink

{% note tip "" %}

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

{% endnote %}

Scope: disk

Who can execute the method: user with "Read" access permission for the required folder

The method disk.folder.getExternalLink returns a public link to the folder.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || id* integer | Identifier of the folder.

The identifier can be obtained using the method disk.storage.getChildren if the folder is in the root of the storage, and using the method disk.folder.getChildren if the folder is in another folder || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":8930}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.folder.getExternalLink

  • cURL (OAuth)

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

  • 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

try {
  const response = await $b24.actions.v2.call.make<string>({
    method: 'disk.folder.getExternalLink',
    params: {
      id: 8930,
    },
    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('External link:', result)
  }
} 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 getFolderExternalLink() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'disk.folder.getExternalLink',
        params: {
          id: 8930,
        },
        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('External link:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', getFolderExternalLink)
</script>

  • Python

    from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.disk.folder.get_external_link(
        bitrix_id=8930,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Bitrix API error",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Bitrix SDK error: {error.message}")
except Exception as error:
    print(f"Unexpected error: {error}")

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'disk.folder.getExternalLink',
            [
                'id' => 8930
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    "disk.folder.getExternalLink",
    {
        id: 8930
    },
    function (result) {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call(
    'disk.folder.getExternalLink',
    [
        'id' => 8930
    ]
);

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, "disk.folder.getExternalLink", b24.Params{
	"id": 8930,
})
if err != nil {
	return fmt.Errorf("disk.folder.getExternalLink: %w", err)
}

var value string
if err := json.Unmarshal(res.Result, &value); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println("result:", value)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": "https://test.bitrix24.com/~Co13P",
    "time": {
        "start": 1768397792,
        "finish": 1768397792.968311,
        "duration": 0.968311071395874,
        "processing": 0,
        "date_start": "2026-01-14T15:36:32+02:00",
        "date_finish": "2026-01-14T15:36:32+02:00",
        "operating_reset_at": 1768398392,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result string | Public link to the folder || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400

{
    "error":"ERROR_ARGUMENT",
    "error_description":"Invalid value of parameter {Parameter #1}"
}

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || ERROR_ARGUMENT | Invalid value of parameter {Parameter #1} | Required parameter id is missing || || ERROR_NOT_FOUND | Could not find entity with id X | Folder with the specified id was not found || || ACCESS_DENIED | Access denied | Insufficient permissions to obtain the link to the folder || |#

{% include system errors %}

Continue Learning