Account


Representa a las cuentas de usuario. Una cuenta de usuario se utiliza para registrarse, iniciar sesión e identificarse en el API.

Modelo Account

{
    "id": 175,
    "email": "pedrop@manzanares.com.ve",
    "type": 255,
    "status": 37104,
    "created_at": "2020-04-20 15:24:38",
    "updated_at": "2023-11-14 17:15:59",
    "deleted_at": null,
    "type_name": "admin",
    "is_status_disabled": false,
    "is_status_blocked": false,
    "is_phone_verified": true,
    "is_email_verified": true,
    "is_identity_verified": false,
    "is_active": true,
    "status_info": {
        "disabled": false,
        "blocked": false,
        "unverified": false,
        "unconfirmed": false,
        "active": true
    }
}
Atributo Tipo Descripción
id int -
email string -
type int -
status int -
created_at datetime\|null -
updated_at datetime\|null -
type_name string\|null -
is_status_disabled bool BitMask (({@link self::status} & 0x100) !== 0)
is_status_blocked bool BitMask (({@link self::status} & 0x200) !== 0)
is_phone_verified bool BitMask (({@link self::status} & 0x400) === 0)
is_email_verified bool BitMask (({@link self::status} & 0x800) === 0)
is_identity_verified bool BitMask (({@link self::status} & 0x2000) !== 0)
is_active bool BitMask ((({@link self::status} & 0xf00) >> 8) === 0)
status_info array -

Listar Account

{info} Soporta: Paginación Filters Carga dinámica

Método URI Cabeceras
GET /companies/{companyId}/accounts Authorization

Listar Setting

Método URI Cabeceras
GET /companies/{companyId}/accounts/{accountId}/settings Authorization

Mostrar Account

Método URI Cabeceras
GET /companies/{companyId}/accounts/{accountId} Authorization

Actualizar Account

Actualizar Setting

Método URI Cabeceras
PATCH /companies/{companyId}/accounts/{accountId}/settings Authorization
{
    "telegram_id": "string",
    "telegram_actions": "array"
}

Eliminar Account

Método URI Cabeceras
DELETE /companies/{companyId}/accounts/{accountId} Authorization

Restaurar Account

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/restore Authorization

Acciones de Account

Verify Phone

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/verify-phone/{code} N/A
{
    "phone": "required|string"
}

Send Phone Code

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/send-phone-code N/A
{
    "phone": "required|string"
}

Disable

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/disable Authorization

Block

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/block Authorization

Activate

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/activate Authorization

Update Password

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/update-password Authorization
{
    "old_password": "required|min:5",
    "new_password": "required|min:5|different:old_password"
}

Update Email

Método URI Cabeceras
POST /companies/{companyId}/accounts/{accountId}/update-email Authorization
{
    "email": "required|email:rfc,filter"
}

Index Allowed

Método URI Cabeceras
GET /companies/{companyId}/accounts/{accountId}/allowed-settings Authorization

Enlaces de Account