Wialon para desarrolladores Manual de usuario Documentación de API core get_account_data

get_account_data

Para obtener información sobre la cuenta del usuario actual y su plan de facturación (nombre del plan de facturación, saldo, días restantes, servicios disponibles), utilice el método core/get_account_data.

Endpoint

Copied!
svc=core/get_account_data&params={
  "type": <uint>
}

Parámetros

La solicitud debe contener el siguiente parámetro:

Parámetro Descripción
type Tipo de información devuelta. Valores posibles:

Respuesta

Si la solicitud se completa con éxito, la respuesta contiene información básica o detallada, según el valor del parámetro type.

Si la solicitud se ejecuta para una cuenta de nivel superior, la respuesta no contiene los campos parentAccountName, parentAccountId y parentEnabled, ya que una cuenta de nivel superior no tiene cuenta padre.

Información básica

Si el parámetro type es 1, la respuesta se devuelve en el siguiente formato:

Copied!
{
  "parentAccountName": <text>,  /* Nombre de la cuenta padre. */
  "parentAccountId": <long>,    /* ID de la cuenta padre. */
  "parentEnabled": <int>,       /* Estado de la cuenta padre: 0 (bloqueada), 1 (activa). */
  "plan": <text>,               /* Nombre del plan de facturación. */
  "enabled": <int>,             /* Estado de la cuenta: 0 (bloqueada), 1 (activa). */
  "switchTime": <uint>,         /* Última modificación del estado de la cuenta (marca de tiempo Unix). */
  "created": <uint>,            /* Hora de creación de la cuenta (marca de tiempo Unix). */
  "flags": <uint>,              /* Flags del plan de facturación. */
  "balance": <text>,            /* Saldo (con moneda). */
  "daysCounter": <int>,         /* Contador de días. */
  "services": {                 /* Servicios. */
    <text>: {                   /* Nombre del servicio. */
      "type": <int>,            /* Tipo de servicio: 1 (bajo demanda), 2 (periódico). */
      "usage": <uint>,          /* Cantidad de elementos utilizados de este servicio. */
      "maxUsage": <int>         /* Cantidad máxima de elementos de este servicio. */
    },
    ...
  },
  "dealerRights": <int>,        /* Derechos de distribuidor para el plan de facturación: 0 (no), 1 (sí). Solo se devuelve si la cuenta tiene derechos de distribuidor. */
  "subPlans": [<text>]          /* Planes de facturación subordinados. Solo se devuelve si la cuenta tiene derechos de distribuidor. */
}

Información detallada

Si el parámetro type es 2 o 10, la respuesta se devuelve en el siguiente formato:

Respuesta
Copied!
{
  "parentAccountName": <text>,  /* Nombre de la cuenta padre. */
  "parentAccountId": <long>,    /* ID de la cuenta padre. */
  "parentEnabled": <int>,       /* Estado de la cuenta padre: 0 (bloqueada), 1 (activa). */
  "plan": <text>,               /* Nombre del plan de facturación. */
  "enabled": <int>,             /* Estado de la cuenta: 0 (bloqueada), 1 (activa). */
  "switchTime": <uint>,         /* Última modificación del estado de la cuenta (marca de tiempo Unix). */
  "created": <uint>,            /* Hora de creación de la cuenta (marca de tiempo Unix). */
  "flags": <uint>,              /* Flags del plan de facturación. Duplica los flags de la configuración del plan de facturación. */
  "balance": <text>,            /* Saldo (con moneda). */
  "daysCounter": <int>,         /* Contador de días. */
  "settings": {                 /* Configuración. */
    "balance": <double>,        /* Saldo. */
    "plan": {                   /* Configuración del plan de facturación. */
      "flags": <uint>,          /* Flags del plan de facturación. */
      "blockBalance": <double>, /* Saldo por debajo del cual se bloquea la cuenta. */
      "denyBalance": <double>,  /* Saldo por debajo del cual los servicios de pago no están disponibles. */
      "minDaysCounter": <int>,  /* Cantidad de días por debajo de la cual se bloquea la cuenta. */
      "historyPeriod": <uint>,  /* Período de almacenamiento de mensajes, en días. 0 significa ilimitado. */
      "currencyFormat": <text>, /* Formato de moneda. */
      "services": {             /* Servicios. */
        <text>: {               /* Nombre del servicio. */
          "type": <int>,        /* Tipo de servicio: 1 (bajo demanda), 2 (periódico). */
          "usage": <uint>,      /* Cantidad de elementos utilizados de este servicio. */
          "maxUsage": <int>,    /* Cantidad máxima de elementos de este servicio. */
          "cost": <text>,       /* Tabla de costes. */
          "interval": <int>,    /* Intervalo de reinicio: 0 (ninguno), 1 (cada hora), 2 (diariamente), 3 (semanalmente), 4 (mensualmente). */
          "descr": <text>       /* Descripción. */
        },
        ...
      }
    },
    "personal": {               /* Configuración de la cuenta. */
      ...                       /* En el mismo formato que la configuración del plan de facturación, sin currencyFormat. */
    },
    "combined": {               /* Configuración combinada del plan de facturación y de la cuenta. */
      ...                       /* En el mismo formato que la configuración del plan de facturación, sin currencyFormat. */
    },
    "siteAccess": {             /* Sitios disponibles para la cuenta. */
      <text>: <text>,           /* Clave: nombre del servicio. Valor: nombre DNS o, si el parámetro type es 10, detalles del sitio. */
      ...
    },
    "serviceKeys": {            /* Proveedores de mapas externos. */
      ...
    }
  },
  "dealerRights": <int>,        /* Derechos de distribuidor para el plan de facturación: 0 (no), 1 (sí). */
  "subPlans": [<text>]          /* Planes de facturación subordinados. */
}

Los flags de la cuenta y del plan de facturación, los tipos de claves de servicio, la lista de servicios y el formato de los detalles de los sitios se describen en la página account/get_account_data.

Para obtener más información sobre la configuración de la cuenta y del plan de facturación, consulte account/update_billing_plan.

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error Descripción
4 Parámetros de entrada incorrectos, o no se pudo obtener el usuario actual o su cuenta.

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.