Skip to main content

Set user status

Sets the status (online) of the current user

Function SetUserStatus(Val URL, Val Status, Val Token = "") Export

ParameterCLI optionTypeDescription
URL--urlStringURL of webhook or a Bitrix24 domain, when token used
Status--statusString, NumberStatus value: online, dnd, away
Token--tokenStringAccess token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

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


Code example
    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
Status = "dnd";

Result = OPI_Bitrix24.SetUserStatus(URL, Status);

URL = "b24-ar17wx.bitrix24.by";
Token = "b529cb66006e9f06006b12e400000001000...";
Status = "away";

Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
CLI command example
    
oint bitrix24 SetUserStatus --url "b24-ar17wx.bitrix24.by" --status "away" --token "fe3fa966006e9f06006b12e400000001000..."

Result
{
"result": true,
"time": {
"start": 1722083795.3692,
"finish": 1722083795.39818,
"duration": 0.0289750099182129,
"processing": 0.00522208213806152,
"date_start": "2024-07-27T12:36:35+00:00",
"date_finish": "2024-07-27T12:36:35+00:00",
"operating_reset_at": 1722084395,
"operating": 0
}
}