Get user status

Gets the status (online) of the current user

Parameters

Function GetUserStatus(Val URL, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: im.user.status.get

1C:Enterprise/OneScript code example

    URL = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";

    Result = OPI_Bitrix24.GetUserStatus(URL);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "a5b00469006e9f06006b12e400000001000...";

    Result = OPI_Bitrix24.GetUserStatus(URL, Token);

Bash

    oint bitrix24 GetUserStatus \
      --url "b24-ar17wx.bitrix24.by" \
      --token "***"

CMD/Bat

    oint bitrix24 GetUserStatus ^
      --url "b24-ar17wx.bitrix24.by" ^
      --token "***"

Result

{
 "result": "away",
 "time": {
  "start": 1779804791,
  "finish": 1779804791.91119,
  "duration": 0.911190986633301,
  "processing": 0,
  "date_start": "2026-05-26T14:13:11+00:00",
  "date_finish": "2026-05-26T14:13:11+00:00",
  "operating_reset_at": 1779805391,
  "operating": 0
 }
}