Skip to content

imopenlines-revision-get.md

Latest commit

 

History

History
247 lines (195 loc) · 6.16 KB

imopenlines-revision-get.md

File metadata and controls

247 lines (195 loc) · 6.16 KB
Raw

Get Information About API Revisions imopenlines.revision.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: imopenlines

Who can execute the method: any user

The method imopenlines.revision.get retrieves information about the API revisions of Open Channels.

Method Parameters

No parameters.

Code Examples

{% include Example Footnote %}

{% list tabs %}

  • cURL (Webhook)

    curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imopenlines.revision.get

  • cURL (OAuth)

    curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/imopenlines.revision.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 RevisionGetResult = {
  rest: number
  web: number
  mobile: number
}

try {
  const response = await $b24.actions.v2.call.make<RevisionGetResult>({
    method: 'imopenlines.revision.get',
    params: {},
    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('REST revision:', result.rest, '| Web revision:', result.web, '| Mobile revision:', result.mobile)
  }
} 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 getOpenLinesRevision() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'imopenlines.revision.get',
        params: {},
        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('REST revision:', result.rest, '| Web revision:', result.web, '| Mobile revision:', result.mobile)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

  • PHP

    try {
    $response = $b24Service
        ->core
        ->call(
            'imopenlines.revision.get',
            []
        );

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

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

  • BX24.js

    BX24.callMethod(
    'imopenlines.revision.get',
    {},
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);

  • PHP CRest

    require_once('crest.php');

$result = CRest::call('imopenlines.revision.get', []);

print_r($result);

  • Go

    // client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "imopenlines.revision.get", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("imopenlines.revision.get: %w", err)
}

var item struct {
	Rest   int `json:"rest"`
	Web    int `json:"web"`
	Mobile int `json:"mobile"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.Rest, item.Web)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": {
        "rest": 2,
        "web": 1,
        "mobile": 1
    },
    "time": {
        "start": 1773660116,
        "finish": 1773660116.269681,
        "duration": 0.2696809768676758,
        "processing": 0,
        "date_start": "2026-03-16T14:21:56+01:00",
        "date_finish": "2026-03-16T14:21:56+01:00",
        "operating_reset_at": 1773660716,
        "operating": 0
    }
}

Returned Data

#| || Name type | Description || || result object | Root object with API revisions (detailed description) || || time time | Information about the request execution time || |#

Object result {#result}

#| || Name type | Description || || rest integer | API revision for REST clients || || web integer | API revision for web and desktop clients || || mobile integer | API revision for mobile clients || |#

Error Handling

{% include notitle error handling %}

{% include system errors %}

Continue Learning