Action registered_users__get
System ID:
action_registered_users__get
In the scenario also:registered_users__get
Description
Looks up a registered user by chat_id + channel or by phone (check_by_phone + reg_phone). If found — activates the record, optionally updates the binding to the current chat (omnichannel), and writes data to the registration and client constants.
Constants after success
| Constant | Contents | Example in a message |
|---|---|---|
client |
Profile row (standard columns: first_name, phone, email, …) |
{{client.first_name}} |
registration |
Custom fields object from the data column |
{{registration.custom_field}} (dot path) |
After __get, do not use {{registration:first_name}} with a colon — that is a flat key the action does not set. For the name from the standard column use {{client.first_name}}.
For writing a profile (registered_users__set), input constants such as reg_first_name / registration:first_name are accepted instead — see registered_users__set.
Events (scenario branches)
| Event | When it occurs |
|---|---|
| success | User found, data loaded |
| error | User not found (or no reg_phone when searching by phone) |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
check_by_phone |
boolean | no | false |
Search by reg_phone instead of chat_id / channel |
If check_by_phone: true, the reg_phone constant is required (usually after registered_users__check_phone).
Configuration example
{
"check_by_phone": true
}
Constants:
{
"reg_phone": "380501234567"
}