Action close_chatroom
System ID:
action_close_chatroom
Description
Programmatically closes an operator chat room. The ID is taken from the parameter or from the Operator Panel module state. Only rooms in statuses new, processed, queue are closed; the close status is marked as closed by the scenario.
Events (scenario branches)
| Event | When it occurs |
|---|---|
| success | Chat room closed successfully |
| no_chatroom_id | No ID in parameters or in Operator Panel state |
If the room is not found or is no longer in a closable status — there is no named branch (undefined).
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chat_room_id |
string / number | No | null |
Chat room ID. If unset — taken from Operator Panel state |
Configuration example
{
"chat_room_id": "123"
}