Elenco utenti bot | Userbot | Documentazione per sviluppatori

Recupera un elenco paginato di utenti finali collegati a un bot. Vengono restituiti solo gli utenti con un record chatusers per il bot richiesto.

Scope token di accesso richiesti: Sessions

AuthorizationBearer

Autenticazione bearer nella forma Bearer <token>, dove token è il tuo token di autenticazione.

bot_keyanyObbligatorio

Chiave pubblica del bot configurata nella dashboard Userbot. Identifica di quale bot elencare gli utenti.

emailstringOpzionale

Filtra per indirizzo email (match parziale, case-insensitive)

phonestringOpzionale

Filtra per numero di telefono (match parziale)

searchstringOpzionale

Cerca nickname, nome o cognome (match parziale)

userIddoubleOpzionale<=9007199254740991

Filtra per ID utente esatto

isTestUserenumOpzionale

Filtra per flag utente di test (true o false)

Valori consentiti:

limitdoubleOpzionale1-100Predefinito a 20

Numero massimo di utenti da restituire. Default 20. Valori compresi tra 1 e 100.

offsetdoubleOpzionale0-9007199254740991Predefinito a 0

Numero di utenti corrispondenti da saltare prima di restituire i risultati. Default 0.

Utenti bot recuperati con successo

userslist of objects

totaldouble

Numero totale di utenti corrispondenti

limitdouble

offsetdouble

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

$	curl https://api.userbot.ai/v1/bots/bot_key/users \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"