Saltar al contenido principal

API de estado de cuentas

Esta página documenta el endpoint de API para consultar el estado de todas las cuentas gestionadas en TikMatrix, incluido el estado en línea/fuera de línea del dispositivo, el estado de inicio de sesión y las etiquetas.

Listar cuentas

Recupera todas las cuentas con información de estado enriquecida.

  • Endpoint: GET /api/v1/accounts

Parámetros de consulta

ParámetroTipoPredeterminadoDescripción
platformstringFiltrar por plataforma: tiktok o instagram
devicestringFiltrar por número de serie del dispositivo
loginedintegerFiltrar por estado de inicio de sesión: 0 = no ha iniciado sesión, 1 = ha iniciado sesión
statusintegerFiltrar por estado de la cuenta: 0 = habilitada, 1 = deshabilitada
tagstringFiltrar por etiqueta (coincidencia exacta)
pageinteger1Número de página (base 1)
page_sizeinteger20Elementos por página (máximo 100)

Campos de respuesta

CampoTipoDescripción
accountsarrayLista de objetos de cuenta (ver abajo)
totalintegerNúmero total de cuentas que coinciden con los filtros
pageintegerNúmero de página actual
page_sizeintegerElementos por página

Objeto de cuenta

CampoTipoDescripción
idintegerID de la cuenta en la base de datos
usernamestring | nullNombre de usuario de la red social
emailstring | nullDirección de correo electrónico de la cuenta
platformstringPlataforma: tiktok o instagram
packagenamestring | nullNombre del paquete de la app clonada (null = app predeterminada)
devicestring | nullNúmero de serie del dispositivo ADB
device_onlinebooleanSi el dispositivo está conectado actualmente
device_namestringNombre del modelo del dispositivo (cadena vacía cuando está fuera de línea)
loginedinteger0 = no ha iniciado sesión, 1 = ha iniciado sesión
logined_textstring"logged_in" o "not_logged_in"
statusinteger0 = habilitada, 1 = deshabilitada
status_textstring"enabled" o "disabled"
tagsstring[]Etiquetas asignadas a esta cuenta
Seguridad

La contraseña de la cuenta nunca se incluye en las respuestas de la API.

Ejemplo

curl "http://localhost:50809/api/v1/accounts?page=1&page_size=20"

Filtrar por plataforma y estado de inicio de sesión:

curl "http://localhost:50809/api/v1/accounts?platform=tiktok&logined=1&page=1&page_size=50"

Filtrar por número de serie del dispositivo:

curl "http://localhost:50809/api/v1/accounts?device=emulator-5554"

Respuesta de ejemplo

{
"code": 0,
"message": "success",
"data": {
"accounts": [
{
"id": 1,
"username": "my_tiktok_user",
"email": "user@example.com",
"platform": "tiktok",
"packagename": null,
"device": "emulator-5554",
"device_online": true,
"device_name": "sdk_gphone64_x86_64",
"logined": 1,
"logined_text": "logged_in",
"status": 0,
"status_text": "enabled",
"tags": ["batch-a", "vip"]
},
{
"id": 2,
"username": "another_user",
"email": null,
"platform": "tiktok",
"packagename": "com.zhiliaoapp.musically.clone1",
"device": "192.168.1.101:5555",
"device_online": false,
"device_name": "",
"logined": 0,
"logined_text": "not_logged_in",
"status": 1,
"status_text": "disabled",
"tags": []
}
],
"total": 2,
"page": 1,
"page_size": 20
}
}

Respuestas de error

Estado HTTPCódigoDescripción
40340301Prohibido — el acceso a la API requiere el plan Pro+
50050001Error interno del servidor