Consola

Tarjetas De Lealtad

Operaciones de tarjetas de lealtad

Copy for LLMView as Markdown
Obtener Configuración de Lealtad
POST /loyalty/get
Agregar Contacto de Lealtad
POST /loyalty/contact/add
Obtener Contacto de Lealtad
POST /loyalty/contact/get
Registrar Sello de Lealtad
POST /loyalty/sale

The Tarjetas De Lealtad object

Returned by the tarjetas de lealtad endpoints.

Attributes
successboolean
—
resultarray<object>
—
statusinteger
—
codestring
Código de respuesta
Copy for LLM
The Tarjetas De Lealtad object
{
  "success": true,
  "result": [],
  "status": 200,
  "code": "loyalty_get_01"
}

Obtener Configuración de Lealtad

POST https://api.smsmasivos.com.mx/loyalty/get

Devuelve la configuración de tarjetas de lealtad del usuario autenticado

Copy for LLMView as Markdown
curl https://api.smsmasivos.com.mx/loyalty/get
const Tarjetas de Lealtad = await sms.tarjetasdelealtad.create()
Tarjetas de Lealtad = sms.tarjetasdelealtad.create()
Tarjetas de Lealtad, err := client.Tarjetasdelealtad.Create(ctx, nil)
Response
{
  "success": true,
  "result": [
    {
      "loyalty_name": "<string>",
      "loyalty_key": "<string>",
      "loyalty_app_client": "<string>",
      "loyalty_plan_type": "<string>"
    }
  ],
  "status": 200,
  "code": "loyalty_get_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"
}

Agregar Contacto de Lealtad

POST https://api.smsmasivos.com.mx/loyalty/contact/add

Registra un contacto en el programa de lealtad

Parameters
loyalty_keystringrequired
Clave identificadora de la tarjeta de lealtad
phonestringrequired
Número de teléfono (exactamente 10 dígitos)
customer_namestringrequired
Nombre del contacto
usertool_idintegerrequired
ID del usuario de herramienta / colaborador
Copy for LLMView as Markdown
curl https://api.smsmasivos.com.mx/loyalty/contact/add \
  -d loyalty_key=value \
  -d phone=value \
  -d customer_name=value \
  -d usertool_id=100
const Tarjetas de Lealtad = await sms.tarjetasdelealtad.create({
  loyalty_key: 'value',
  phone: 'value',
  customer_name: 'value',
  usertool_id: 100,
})
Tarjetas de Lealtad = sms.tarjetasdelealtad.create(
    loyalty_key="value",
    phone="value",
    customer_name="value",
    usertool_id=100,
)
Tarjetas de Lealtad, err := client.Tarjetasdelealtad.Create(ctx, &sms.TarjetasDeLealtadParams{
    LoyaltyKey: sms.String("value"),
    Phone: sms.String("value"),
    CustomerName: sms.String("value"),
    UsertoolId: sms.Int(100),
})
Response
{
  "success": true,
  "message": "Venta creada correctamente.",
  "status": 200,
  "code": "loyalty_sale_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 Contacto de Lealtad

POST https://api.smsmasivos.com.mx/loyalty/contact/get

Obtiene los detalles de tarjeta de lealtad de un contacto

Parameters
loyalty_keystringrequired
Clave de tarjeta de lealtad
phonestringoptional
Número de teléfono para filtrar
Copy for LLMView as Markdown
curl https://api.smsmasivos.com.mx/loyalty/contact/get \
  -d loyalty_key=value \
  -d phone=value
const Tarjetas de Lealtad = await sms.tarjetasdelealtad.create({
  loyalty_key: 'value',
  phone: 'value',
})
Tarjetas de Lealtad = sms.tarjetasdelealtad.create(
    loyalty_key="value",
    phone="value",
)
Tarjetas de Lealtad, err := client.Tarjetasdelealtad.Create(ctx, &sms.TarjetasDeLealtadParams{
    LoyaltyKey: sms.String("value"),
    Phone: sms.String("value"),
})
Response
{
  "success": true,
  "result": [
    {
      "contact_name": "<string>",
      "contact_phone": "<string>",
      "contact_birthdate": "<string>",
      "contact_total_loyalty_completes": 0,
      "contact_current_redeem": 0
    }
  ],
  "status": 200,
  "code": "loyalty_contact_get_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"
}

Registrar Sello de Lealtad

POST https://api.smsmasivos.com.mx/loyalty/sale

Registra un sello/venta de lealtad para un contacto

Parameters
loyalty_keystringrequired
Clave de tarjeta de lealtad
phonestringrequired
Número de teléfono
usertool_idintegerrequired
ID del usuario de herramienta / colaborador
Copy for LLMView as Markdown
curl https://api.smsmasivos.com.mx/loyalty/sale \
  -d loyalty_key=value \
  -d phone=value \
  -d usertool_id=100
const Tarjetas de Lealtad = await sms.tarjetasdelealtad.create({
  loyalty_key: 'value',
  phone: 'value',
  usertool_id: 100,
})
Tarjetas de Lealtad = sms.tarjetasdelealtad.create(
    loyalty_key="value",
    phone="value",
    usertool_id=100,
)
Tarjetas de Lealtad, err := client.Tarjetasdelealtad.Create(ctx, &sms.TarjetasDeLealtadParams{
    LoyaltyKey: sms.String("value"),
    Phone: sms.String("value"),
    UsertoolId: sms.Int(100),
})
Response
{
  "success": true,
  "message": "Venta creada correctamente.",
  "status": 200,
  "code": "loyalty_sale_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"
}