1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-25 22:12:29 +02:00
Files
OpenIntegrations/docs/en/md/Bitrix24/Chats-and-dialogs-management/Set-user-status.mdx
Vitaly the Alpaca (bot) 47fa4e92bb Main build (Jenkins)
2025-06-27 11:47:43 +03:00

86 lines
2.3 KiB
Plaintext
Vendored

---
sidebar_position: 18
description: Set user status and other functions to work with Bitrix24 in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, Bitrix24]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Set user status
Sets the status (online) of the current user
`Function SetUserStatus(Val URL, Val Status, Val Token = "") Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| URL | --url | String | ✔ | URL of webhook or a Bitrix24 domain, when token used |
| Status | --status | String, Number | ✔ | Status value: online, dnd, away |
| Token | --token | String | ✖ | Access token, when app auth method used |
Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API
<br/>
:::tip
Method at API documentation: [im.user.status.set](https://dev.1c-bitrix.ru/learning/course/index.php?COURSE_ID=93&LESSON_ID=11499)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
URL = FunctionParameters["Bitrix24_URL"];
Status = "dnd";
Result = OPI_Bitrix24.SetUserStatus(URL, Status);
URL = FunctionParameters["Bitrix24_Domain"];
Token = FunctionParameters["Bitrix24_Token"];
Status = "away";
Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint bitrix24 SetUserStatus \
--url "b24-ar17wx.bitrix24.by" \
--status "away" \
--token "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint bitrix24 SetUserStatus ^
--url "b24-ar17wx.bitrix24.by" ^
--status "away" ^
--token "***"
```
</TabItem>
</Tabs>
```json title="Result"
{
"result": true,
"time": {
"start": 1728454841.60883,
"finish": 1728454841.64357,
"duration": 0.0347371101379394,
"processing": 0.00739097595214844,
"date_start": "2024-10-09T09:20:41+03:00",
"date_finish": "2024-10-09T09:20:41+03:00",
"operating_reset_at": 1728455441,
"operating": 0
}
}
```