Colaboradores

Gestión de los colaboradores de tu cuenta
Obtener colaboradores
POST /toolusers/get
Agregar colaborador
POST /employee/add
Deshabilitar colaborador
POST /employee/disable

Obtener colaboradores

POST https://api.smsmasivos.com.mx/toolusers/get
Lista todos los colaboradores de la cuenta
curl https://api.smsmasivos.com.mx/toolusers/get
const Colaboradore = await sms.colaboradores.create()
Colaboradore = sms.colaboradores.create()
Colaboradore, err := client.Colaboradores.Create(ctx, nil)
Response
{
  "success": true,
  "result": [
    {
      "usertool_id": 0,
      "usertool_name": "<string>",
      "usertool_number": "<string>",
      "usertool_branch": "<string>",
      "usertool_type": "<string>",
      "usertool_status": "<string>"
    }
  ],
  "code": "tool_users_01"
}
{
  "success": false,
  "message": "Parámetros inválidos.",
  "status": 200,
  "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 envíos de prueba/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 200,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Agregar colaborador

POST https://api.smsmasivos.com.mx/employee/add
Registra un nuevo colaborador. Valida contraseña única, nombre de usuario y teléfono
Cuerpo de la solicitud
typestringrequerido
Rol: cajero o gerente
employee_namestringrequerido
Nombre del colaborador
business_namestringrequerido
Nombre del negocio/sucursal
numberstringrequerido
Número de teléfono (exactamente 10 dígitos)
passwordstringrequerido
Contraseña (máx. 50 caracteres)
curl https://api.smsmasivos.com.mx/employee/add \
  -d type=value \
  -d employee_name=value \
  -d business_name=value \
  -d number=value
const Colaboradore = await sms.colaboradores.create({
  type: 'value',
  employee_name: 'value',
  business_name: 'value',
  number: 'value',
})
Colaboradore = sms.colaboradores.create(
    type="value",
    employee_name="value",
    business_name="value",
    number="value",
)
Colaboradore, err := client.Colaboradores.Create(ctx, &sms.ColaboradoreParams{
    Type: sms.String("value"),
    EmployeeName: sms.String("value"),
    BusinessName: sms.String("value"),
    Number: sms.String("value"),
})
Response
{
  "success": true,
  "message": "partner_created_successfully",
  "collaboratorId": 101,
  "status": 200,
  "code": "toolusers_01"
}
{
  "success": false,
  "message": "Parámetros inválidos.",
  "status": 200,
  "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": "Parámetros inválidos.",
  "status": 200,
  "code": "<string>"
}
{
  "success": false,
  "message": "Demasiadas solicitudes. Límite: 100 mensajes/segundo (producción) o 100 envíos de prueba/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 200,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Deshabilitar colaborador

POST https://api.smsmasivos.com.mx/employee/disable
Deshabilita un colaborador por número de teléfono
Cuerpo de la solicitud
numberstringrequerido
Número de teléfono del colaborador
curl https://api.smsmasivos.com.mx/employee/disable \
  -d number=value
const Colaboradore = await sms.colaboradores.create({
  number: 'value',
})
Colaboradore = sms.colaboradores.create(
    number="value",
)
Colaboradore, err := client.Colaboradores.Create(ctx, &sms.ColaboradoreParams{
    Number: sms.String("value"),
})
Response
{
  "success": true,
  "message": "partner_disabled",
  "status": 200,
  "code": "toolusers_01"
}
{
  "success": false,
  "message": "Parámetros inválidos.",
  "status": 200,
  "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 envíos de prueba/día (sandbox).",
  "status": 429,
  "code": "rate_01"
}
{
  "success": false,
  "message": "Error interno del servidor. Contacta a soporte con el request_id.",
  "status": 200,
  "code": "server_01",
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Objeto de respuesta

Estructura de la respuesta que devuelven estos endpoints.

Atributos
successboolean
—
messagestring
Mensaje de estado
collaboratorIdinteger
ID del nuevo colaborador
statusinteger
—
codestring
Código de respuesta
Objeto de respuesta
{
  "success": true,
  "message": "partner_created_successfully",
  "collaboratorId": 101,
  "status": 200,
  "code": "toolusers_01"
}