Subcuentas

Administración de subcuentas

Crear Subcuenta
POST /manager/subaccount/add
Archivar Subcuenta
POST /manager/subaccount/archive
Obtener API Key de Subcuenta
POST /manager/subaccount/get_apikey
Gestionar Créditos de Subcuenta
POST /manager/subaccount/credits/manage

The Subcuenta object

Returned by the subcuentas endpoints.

Attributes
successboolean
messagestring
Mensaje de estado
statusinteger
codestring
Código de respuesta
apikeystring
API Key generada
emailstring
Email de la subcuenta
The Subcuenta object
{
  "success": true,
  "message": "user_created",
  "status": 200,
  "code": "subaccount_01",
  "apikey": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "email": "[email protected]"
}

Crear Subcuenta

POST https://api.smsmasivos.com.mx/manager/subaccount/add

Crea una nueva subcuenta bajo el manager. Email máx. 70 caracteres, contraseña 6-36 caracteres

Parameters
emailstringrequired
Email de la subcuenta (máx. 70 caracteres, formato válido)
passwordstringrequired
Contraseña de la subcuenta (6-36 caracteres)
curl https://api.smsmasivos.com.mx/manager/subaccount/add \
  -d email=value \
  -d password=value
const Subcuenta = await sms.subcuentas.create({
  email: 'value',
  password: 'value',
})
Subcuenta = sms.subcuentas.create(
    email="value",
    password="value",
)
Subcuenta, err := client.Subcuentas.Create(ctx, &sms.SubcuentaParams{
    Email: sms.String("value"),
    Password: sms.String("value"),
})
Response
{
  "success": true,
  "message": "user_created",
  "status": 200,
  "code": "subaccount_01",
  "apikey": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "email": "[email protected]"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "<string>"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "auth_05"
}
{
  "success": false,
  "message": "La dirección IP no está autorizada para acceder.",
  "status": 403,
  "code": "auth_04"
}
{
  "success": false,
  "message": "Demasiadas solicitudes. Límite: 100 mensajes/segundo (producción) o 100/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 500,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Archivar Subcuenta

POST https://api.smsmasivos.com.mx/manager/subaccount/archive

Archiva/deshabilita una subcuenta

Parameters
emailstringrequired
Email de la subcuenta (máx. 70 caracteres)
curl https://api.smsmasivos.com.mx/manager/subaccount/archive \
  -d email=value
const Subcuenta = await sms.subcuentas.create({
  email: 'value',
})
Subcuenta = sms.subcuentas.create(
    email="value",
)
Subcuenta, err := client.Subcuentas.Create(ctx, &sms.SubcuentaParams{
    Email: sms.String("value"),
})
Response
{
  "success": true,
  "message": "subaccount_archived",
  "status": 200,
  "code": "subaccount_01"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "<string>"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "auth_05"
}
{
  "success": false,
  "message": "La dirección IP no está autorizada para acceder.",
  "status": 403,
  "code": "auth_04"
}
{
  "success": false,
  "message": "Demasiadas solicitudes. Límite: 100 mensajes/segundo (producción) o 100/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 500,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Obtener API Key de Subcuenta

POST https://api.smsmasivos.com.mx/manager/subaccount/get_apikey

Obtiene la API Key de una subcuenta

Parameters
emailstringrequired
Email de la subcuenta (máx. 70 caracteres)
curl https://api.smsmasivos.com.mx/manager/subaccount/get_apikey \
  -d email=value
const Subcuenta = await sms.subcuentas.create({
  email: 'value',
})
Subcuenta = sms.subcuentas.create(
    email="value",
)
Subcuenta, err := client.Subcuentas.Create(ctx, &sms.SubcuentaParams{
    Email: sms.String("value"),
})
Response
{
  "success": true,
  "status": 200,
  "apikey": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "email": "[email protected]"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "<string>"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "auth_05"
}
{
  "success": false,
  "message": "La dirección IP no está autorizada para acceder.",
  "status": 403,
  "code": "auth_04"
}
{
  "success": false,
  "message": "Demasiadas solicitudes. Límite: 100 mensajes/segundo (producción) o 100/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 500,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Gestionar Créditos de Subcuenta

POST https://api.smsmasivos.com.mx/manager/subaccount/credits/manage

Transfiere créditos hacia o desde una subcuenta

Parameters
emailstringrequired
Email de la subcuenta (máx. 70 caracteres)
typeintegerrequired
Tipo de transferencia
creditsintegeroptional
Número de créditos a transferir
curl https://api.smsmasivos.com.mx/manager/subaccount/credits/manage \
  -d email=value \
  -d type=100 \
  -d credits=100
const Subcuenta = await sms.subcuentas.create({
  email: 'value',
  type: 100,
  credits: 100,
})
Subcuenta = sms.subcuentas.create(
    email="value",
    type=100,
    credits=100,
)
Subcuenta, err := client.Subcuentas.Create(ctx, &sms.SubcuentaParams{
    Email: sms.String("value"),
    Type: sms.Int(100),
    Credits: sms.Int(100),
})
Response
{
  "success": true,
  "message": "subaccount_archived",
  "status": 200,
  "code": "subaccount_01"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "<string>"
}
{
  "success": false,
  "message": "API Key inválida o no existe.",
  "status": 401,
  "code": "auth_05"
}
{
  "success": false,
  "message": "La dirección IP no está autorizada para acceder.",
  "status": 403,
  "code": "auth_04"
}
{
  "success": false,
  "message": "Demasiadas solicitudes. Límite: 100 mensajes/segundo (producción) o 100/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 500,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}