# SMS Masivos API – Extracted Endpoints (generated from OpenAPI v3.0.0)
# Title: SMS Masivos API
# Version: 2.0.0

=== GET /sms/send ===
```bash
# Example: GET /sms/send
curl -X GET "https://api.smsmasivos.com.mx/sms/send" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -G --data-urlencode "param1=value1"
```
Tags: Send SMS
Summary: Envío de mensajes SMS
Description: Esta función realiza el envío de un mensaje SMS configurando los parámetros necesarios, validándolos y procesando el envío.
Headers:
- apikey: string (required) – Tu API key.
Parameters:
- numbers (query, string, required=True) – Números de teléfono destinatarios (obligatorio).
- sandbox (query, integer, required=False) – Indica si los datos a consultar pertenecen al entorno de pruebas (1) o al entorno de producción (0). Por defecto, es 0.
- sender (query, string, required=False) – Identificador del remitente. Si no se tiene contratado se sobreescribe y reemplaza por un código corto.
- message (query, string, required=True) – Contenido del mensaje (obligatorio).
- country_code (query, string, required=True) – Código del país (obligatorio).
- date (query, string, required=False) – Fecha programada para el envío.
- extra_params (query, string, required=False) – Parámetros extra opcionales en formato JSON o string.
Responses:
- 200: Envío procesado exitosamente
- 400: Error en el envío

=== POST /sms/send ===
```bash
# Example: POST /sms/send
curl -X POST "https://api.smsmasivos.com.mx/sms/send" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Send SMS
Summary: Envío de mensajes SMS
Description: Similar al método GET, pero utiliza un cuerpo de solicitud para enviar los datos.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- numbers (string, required=True) – Números de teléfono destinatarios separados por comas en caso de ser varios (obligatorio).
- sandbox (integer, required=False) – Indica si el envío se simula en entorno de pruebas (1) o realmente se envía en entorno de producción (0). Por defecto, es 0.
- sender (string, required=False) – Identificador del remitente, solo disponible si está contratado.
- message (string, required=True) – Contenido del mensaje (obligatorio).
- country_code (string, required=True) – Código del país (obligatorio).
- date (string, required=False) – 
- extra_params (string, required=False) – Parámetros extra opcionales en formato JSON o string.
- shorten_url (integer, required=False) – Indica si la URL encontrada en el mensaje se debe acortar (1) o no se debe acortar (0). Por defecto, es 0
Responses:
- 200: Envío procesado exitosamente
- 400: Error en el envío

=== GET /voice/send ===
```bash
# Example: GET /voice/send
curl -X GET "https://api.smsmasivos.com.mx/voice/send" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -G --data-urlencode "param1=value1"
```
Tags: Send Voice
Summary: Envío de mensajes de voz
Description: Esta función gestiona el envío de mensajes de voz, configurando los parámetros necesarios, validándolos y procesando el envío.  Valida las opciones de plantilla, longitud y formato del mensaje antes de proceder con el envío.
Headers:
- apikey: string (required) – Tu API key.
Parameters:
- sender (query, string, required=False) – Define el remitente para el mensaje de voz.
- numbers (query, string, required=True) – Contiene los números de destinatarios (obligatorio).
- sandbox (query, integer, required=False) – Indica si el envío se simula en entorno de pruebas (1) o realmente se envía en entorno de producción (0). Por defecto, es 0.
- country_code (query, integer, required=True) – Código de país para los destinatarios.
- template (query, string, required=True) – Plantilla para el mensaje de voz.
- voice_message (query, string, required=False) – Mensaje de voz personalizado (solo si `template = 'k'`).
- company (query, string, required=False) – Nombre de la empresa para personalizar el mensaje.
- code (query, string, required=True) – Código de verificación o identificador personalizado (obligatorio).
Responses:
- 200: Mensaje enviado correctamente
- 400: Error en el envío

=== POST /voice/send ===
```bash
# Example: POST /voice/send
curl -X POST "https://api.smsmasivos.com.mx/voice/send" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Send Voice
Summary: Envío de mensajes de voz
Description: Similar al método GET, pero utiliza un cuerpo de solicitud para enviar los datos.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- sender (string, required=False) – Define el remitente para el mensaje de voz.
- voice_method (boolean, required=False) – Activa el modo de mensajes de voz.
- numbers (string, required=True) – Contiene los números de destinatarios.
- sandbox (integer, required=False) – Indica si el envío se simula en entorno de pruebas (1) o realmente se envía en entorno de producción (0). Por defecto, es 0.
- country_code (integer, required=True) – Código de país para los destinatarios.
- template (string, required=True) – Plantilla para el mensaje de voz.
- voice_message (string, required=False) – Mensaje de voz personalizado (solo si `template = 'k'`).
- company (string, required=False) – Nombre de la empresa para personalizar el mensaje.
- code (string, required=True) – Código de verificación o identificador personalizado.
Responses:
- 200: Mensaje enviado correctamente
- 400: Error en el envío

=== POST /paymentrequest/send ===
```bash
# Example: POST /paymentrequest/send
curl -X POST "https://api.smsmasivos.com.mx/paymentrequest/send" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Send Payment Request
Summary: Envío de solicitud de pago
Description: Esta función gestiona la creación y envío de solicitudes de pago. Realiza una validación previa de los datos proporcionados por el usuario y, si los parámetros son válidos, procesa la solicitud mediante la generación de un enlace de pago y la vinculación de la información del usuario, contacto y plantilla correspondiente. También maneja escenarios de error en caso de datos incompletos o inconsistencias.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- number (string, required=True) – Número de contacto del destinatario.
- country_code (string, required=True) – Código de país asociado al número del destinatario.
- template (string, required=True) – Identificador de la plantilla utilizada para la solicitud de pago.
- message (string, required=True) – Mensaje que se enviará junto con la solicitud de pago.
- amount (number, required=False) – Monto de la solicitud de pago. Debe estar entre $15 y $110,000.
- name (string, required=False) – Nombre del destinatario. No puede exceder los 150 caracteres.
- email (string, required=False) – Correo electrónico del destinatario. Debe tener un formato válido.
- custom (string, required=False) – Identificador personalizado. No puede exceder los 25 caracteres.
Responses:
- 200: Solicitud enviada correctamente
- 400: Error en el envío
- 500: Error interno del servidor

=== POST /reports/generate ===
```bash
# Example: POST /reports/generate
curl -X POST "https://api.smsmasivos.com.mx/reports/generate" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Reports
Summary: Generación de Reportes de Campañas y Mensajes Enviados
Description: Esta función permite generar un reporte detallado de campañas y mensajes enviados dentro de un rango de fechas especificado. Valida los parámetros de entrada, consulta las campañas y mensajes asociados al usuario, y devuelve los datos estructurados para su análisis.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- sandbox (integer, required=False) – Indica si los datos a consultar pertenecen al entorno de pruebas (1) o al entorno de producción (0). Por defecto, es 0.
- start_date (string, required=True) – Fecha inicial para filtrar las campañas y mensajes enviados.
- end_date (string, required=True) – Fecha final para filtrar las campañas y mensajes enviados.
- lang (string, required=False) – Idioma del reporte. Puede ser "es" (español) o "en" (inglés).
Responses:
- 200: Reporte generado exitosamente
- 400: Error en los parámetros de entrada
- 500: Error interno al generar el reporte

=== POST /credits/consult ===
```bash
# Example: POST /credits/consult
curl -X POST "https://api.smsmasivos.com.mx/credits/consult" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Credits
Summary: Consulta de Créditos Disponibles
Description: Esta función permite consultar el saldo de créditos disponibles para el usuario actual. Recupera la información directamente desde la base de datos y la devuelve en un formato estructurado.
Headers:
- apikey: string (required) – Tu API key.
Responses:
- 200: Consulta exitosa del saldo de créditos
- 401: API key inválida o no autorizada
- 500: Error interno durante la consulta de créditos

=== POST /contacts/add ===
```bash
# Example: POST /contacts/add
curl -X POST "https://api.smsmasivos.com.mx/contacts/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Contact
Summary: Agregar Contacto
Description: Permite agregar o actualizar un contacto en una lista específica del usuario. Si el contacto ya existe, se actualizan sus datos; de lo contrario, se crea un nuevo contacto.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash de la agenda/canal a la que deseas agregar o actualizar el contacto.
- number (string, required=True) – Número del contacto a registrar. Nota: No debe contener el código de país.
- name (string, required=False) – Nombre del contacto a registrar o actualizar.
- email (string, required=False) – Cuenta de correo electrónico del contacto a registrar o actualizar.
- custom_field_1 (string, required=False) – Campo personalizado del contacto.
- custom_field_2 (string, required=False) – Campo personalizado del contacto.
- custom_field_3 (string, required=False) – Campo personalizado del contacto.
- custom_field_4 (string, required=False) – Campo personalizado del contacto.
- birthday_date (string, required=False) – Fecha de nacimiento del contacto a registrar o actualizar.
- facebook (string, required=False) – Perfil de Facebook del contacto.
- twitter (string, required=False) – Perfil de Twitter del contacto.
- linkedin (string, required=False) – Perfil de LinkedIn del contacto.
- instagram (string, required=False) – Perfil de Instagram del contacto.
- find_country_code (integer, required=False) – Si el número contiene el código de país, habilitar este atributo: - 1: Extraer código de país del número. - 0: Usar el número como se encuentra en el atributo number (por defecto).
- lang (string, required=False) – Idioma de la respuesta: - es: Español (por defecto). - en: Inglés.
Responses:
- 200: Operación exitosa
- 400: Error en los parámetros
- 500: Error interno del servidor

=== POST /contacts/update ===
```bash
# Example: POST /contacts/update
curl -X POST "https://api.smsmasivos.com.mx/contacts/update" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Contact
Summary: Actualizar Contacto
Description: Actualiza la información de tus contactos existentes, como: nombre, número y/o correo electrónico, en cualquier agenda/canal configurado en el panel. Es necesario proporcionar un identificador único (número o correo) para identificar al contacto que se desea actualizar.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash de la agenda/canal en la que se encuentra el contacto.
- number (string, required=False) – Número del contacto a actualizar. Obligatorio si no se incluye email.
- email (string, required=False) – Correo electrónico del contacto a actualizar. Obligatorio si no se incluye number.
- name (string, required=False) – Nombre del contacto a registrar o actualizar.
- custom_field_1 (string, required=False) – Campo personalizado del contacto.
- custom_field_2 (string, required=False) – Campo personalizado del contacto.
- custom_field_3 (string, required=False) – Campo personalizado del contacto.
- custom_field_4 (string, required=False) – Campo personalizado del contacto.
- birthday_date (string, required=False) – Fecha de nacimiento del contacto a registrar o actualizar.
- facebook (string, required=False) – Perfil de Facebook del contacto.
- twitter (string, required=False) – Perfil de Twitter del contacto.
- linkedin (string, required=False) – Perfil de LinkedIn del contacto.
- instagram (string, required=False) – Perfil de Instagram del contacto.
- find_country_code (integer, required=False) – Si el número contiene el código de país, habilitar este atributo: - 1: Extraer código de país del número. - 0: Usar el número como se encuentra en el atributo number (por defecto).
Responses:
- 200: Operación exitosa
- 400: Error al actualizar el contacto
- 500: Error interno del servidor

=== POST /contacts/delete ===
```bash
# Example: POST /contacts/delete
curl -X POST "https://api.smsmasivos.com.mx/contacts/delete" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Contact
Summary: Eliminar Contacto
Description: Elimina un contacto de una agenda configurado en el panel. Es necesario proporcionar un identificador único (número o correo electrónico) para identificar el contacto que se desea eliminar.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash de la agenda/canal de donde se desea eliminar el contacto.
- number (string, required=False) – Número del contacto a eliminar. Obligatorio si no se incluye email.
- email (string, required=False) – Correo electrónico del contacto a eliminar. Obligatorio si no se incluye number.
- lang (string, required=False) – Idioma de la respuesta (opcional).
Responses:
- 200: Operación exitosa
- 400: Contacto no encontrado o parámetros inválidos
- 500: Error interno del servidor

=== POST /contacts/duplicate ===
```bash
# Example: POST /contacts/duplicate
curl -X POST "https://api.smsmasivos.com.mx/contacts/duplicate" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Contact
Summary: Duplicar Contacto
Description: Permite duplicar un contacto de una lista existente a una nueva lista en el panel. Para duplicar el contacto, es necesario proporcionar las claves de las listas origen y destino, así como el identificador del contacto.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- new_list_key (string, required=True) – Clave hash de la nueva lista/canal a la que se desea duplicar el contacto.
- current_list_key (string, required=True) – Clave hash de la lista/canal actual donde se encuentra el contacto a duplicar.
- contact_id (string, required=True) – Identificador único del contacto que se desea duplicar.
- lang (string, required=False) – Idioma de la respuesta (opcional).
Responses:
- 200: Operación exitosa
- 400: Contacto ya existe en la lista destino o parámetros inválidos
- 404: Contacto no encontrado en la lista actual
- 500: Error interno del servidor

=== POST /webhook/get ===
```bash
# Example: POST /webhook/get
curl -X POST "https://api.smsmasivos.com.mx/webhook/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Webhook Delivery Confirmation
Summary: Obtener Configuración del Webhook
Description: Recupera la URL y el estado del webhook configurado para el usuario actual en la plataforma. Este endpoint permite verificar si un webhook está configurado y activo para recibir eventos.
Headers:
- apikey: string (required) – Tu API key.
Responses:
- 200: Operación exitosa o webhook no configurado
- 500: Error interno del servidor

=== POST /webhook/add ===
```bash
# Example: POST /webhook/add
curl -X POST "https://api.smsmasivos.com.mx/webhook/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Webhook Delivery Confirmation
Summary: Agregar o Actualizar Webhook
Description: Permite agregar o actualizar la URL del webhook para recibir notificaciones de eventos en la plataforma. El estado del webhook también puede ser configurado como activo o inactivo.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- url (string, required=True) – URL del webhook donde se recibirán las notificaciones. Debe ser una URL válida.
- status (integer, required=True) – Estado del webhook - 1 Activo. - 0 Inactivo.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Errores de validación de entrada
- 500: Error interno del servidor

=== POST /webhook/status ===
```bash
# Example: POST /webhook/status
curl -X POST "https://api.smsmasivos.com.mx/webhook/status" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Webhook Delivery Confirmation
Summary: Actualizar Estado del Webhook
Description: Permite actualizar el estado de un webhook existente, configurándolo como activo o inactivo.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- url (string, required=True) – URL del webhook cuyo estado se desea modificar. Debe ser una URL válida.
- status (integer, required=True) – Estado del webhook - 1 Activo. - 0 Inactivo.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Errores de validación de entrada
- 500: Error interno del servidor

=== POST /webhook/delete ===
```bash
# Example: POST /webhook/delete
curl -X POST "https://api.smsmasivos.com.mx/webhook/delete" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Webhook Delivery Confirmation
Summary: Eliminar Webhook
Description: Esta función elimina la URL del webhook configurado para recibir notificaciones, desactivándolo completamente.
Headers:
- apikey: string (required) – Tu API key.
Responses:
- 200: Operación exitosa o error al eliminar
- 400: Error al eliminar el webhook
- 500: Error interno del servidor

=== POST /agendas/add ===
```bash
# Example: POST /agendas/add
curl -X POST "https://api.smsmasivos.com.mx/agendas/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Agendas
Summary: Agregar Agenda
Description: Permite crear una nueva agenda para organizar contactos. Se pueden agregar descripciones y campos personalizados para enriquecer la información de la agenda.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- agenda_name (string, required=True) – Nombre de la nueva agenda.
- agenda_description (string, required=False) – Descripción de la agenda.
- custom_field_1 (string, required=False) – Campo personalizado 1 para la agenda.
- custom_field_2 (string, required=False) – Campo personalizado 2 para la agenda.
- custom_field_3 (string, required=False) – Campo personalizado 3 para la agenda.
- custom_field_4 (string, required=False) – Campo personalizado 4 para la agenda.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Errores de validación de entrada
- 500: Error interno del servidor

=== POST /agendas/get ===
```bash
# Example: POST /agendas/get
curl -X POST "https://api.smsmasivos.com.mx/agendas/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Agendas
Summary: Obtener Agendas
Description: Permite consultar todas las agendas registradas asociadas a un usuario. Devuelve el nombre, descripción, fecha de creación y clave única de cada agenda.
Headers:
- apikey: string (required) – Tu API key.
Responses:
- 200: Operación exitosa o sin resultados
- 500: Error interno del servidor

=== POST /agendas/change_name ===
```bash
# Example: POST /agendas/change_name
curl -X POST "https://api.smsmasivos.com.mx/agendas/change_name" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Agendas
Summary: Cambiar Nombre de Agenda
Description: Permite cambiar el nombre de una agenda existente utilizando su clave única (`list_key`). Verifica que la agenda exista antes de realizar el cambio.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash única de la agenda cuyo nombre deseas cambiar.
- agenda_name (string, required=True) – Nuevo nombre que se asignará a la agenda.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Validaciones fallidas
- 500: Error interno del servidor

=== POST /agendas/get_contacts ===
```bash
# Example: POST /agendas/get_contacts
curl -X POST "https://api.smsmasivos.com.mx/agendas/get_contacts" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Agendas
Summary: Obtener Contactos de una Agenda
Description: Este endpoint permite obtener la lista de contactos registrados en una agenda específica utilizando su clave única (`list_key`). Retorna información como el nombre, número, correo electrónico y la fecha de creación de cada contacto.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash única de la agenda cuyos contactos deseas obtener.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Validaciones fallidas
- 500: Error interno del servidor

=== POST /agendas/delete ===
```bash
# Example: POST /agendas/delete
curl -X POST "https://api.smsmasivos.com.mx/agendas/delete" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Agendas
Summary: Eliminar una Agenda
Description: Este endpoint permite eliminar una agenda específica y todos los contactos asociados a ella utilizando la clave única (`list_key`).
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- list_key (string, required=True) – Clave hash única de la agenda que deseas eliminar.
Responses:
- 200: Operación exitosa o errores de validación
- 400: Validaciones fallidas
- 404: Agenda no encontrada
- 500: Error interno del servidor

=== GET /contactlist/find ===
```bash
# Example: GET /contactlist/find
curl -X GET "https://api.smsmasivos.com.mx/contactlist/find" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -G --data-urlencode "param1=value1"
```
Tags: Agendas
Summary: Buscar Agenda por Nombre
Description: Este endpoint permite buscar agendas existentes mediante un nombre parcial o completo ingresado en la consulta. El resultado mostrará las agendas que coincidan con el criterio proporcionado.
Headers:
- apikey: string (required) – Tu API key.
Parameters:
- query (query, string, required=True) – Texto o parte del nombre de la agenda a buscar (máximo 100 caracteres).
Responses:
- 200: Operación exitosa
- 400: Validación fallida
- 500: Error interno del servidor

=== POST /protected/json/phones/verification/start ===
```bash
# Example: POST /protected/json/phones/verification/start
curl -X POST "https://api.smsmasivos.com.mx/protected/json/phones/verification/start" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Generación de Código de Verificación
Description: Este endpoint genera un código de verificación para un número de teléfono con opciones adicionales, como envío por WhatsApp, voz o SMS. También permite personalizar parámetros como longitud del código, tipo de código y plantilla de mensaje.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono para el cual se generará el código (sin caracteres especiales).
- country_code (string, required=True) – Código del país asociado al número de teléfono.
- code_length (integer, required=False) – Longitud del código (opciones 4, 6, etc.).
- company (string, required=False) – Nombre de la empresa asociado al código de verificación.
- voice (boolean, required=False) – Enviar el código a través de una llamada de voz.
- whatsapp (boolean, required=False) – Enviar el código a través de WhatsApp.
- expiration_date (string, required=False) – Fecha de expiración del código en formato YYYY-MM-DD HH:mm:ss (máximo 3 días desde la creación).
- reset_code (boolean, required=False) – Regenerar el código aunque ya exista uno activo.
- code_type (string, required=False) – Tipo de código a generar (numeric, alphanumeric, letters).
- template (string, required=False) – Plantilla para el mensaje de verificación (a, b, c, etc.).
- reference (boolean, required=False) – Incluir una referencia en la respuesta.
- showcode (integer, required=False) – Mostrar el código en la respuesta (1 para mostrar, 0 para ocultar).
Responses:
- 200: Código generado exitosamente o errores de validación
- 400: Validaciones fallidas
- 500: Error interno del servidor

=== POST /protected/xml/phones/verification/start ===
```bash
# Example: POST /protected/xml/phones/verification/start
curl -X POST "https://api.smsmasivos.com.mx/protected/xml/phones/verification/start" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Generación de Código de Verificación en Formato XML
Description: Este endpoint genera un código de verificación para un número de teléfono con opciones adicionales como envío por WhatsApp, voz o SMS. El resultado es devuelto en formato XML.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono para el cual se generará el código (sin caracteres especiales).
- country_code (string, required=True) – Código del país asociado al número de teléfono.
- code_length (integer, required=False) – Longitud del código (opciones 4, 6, etc.).
- company (string, required=False) – Nombre de la empresa asociado al código de verificación.
- voice (boolean, required=False) – Enviar el código a través de una llamada de voz.
- whatsapp (boolean, required=False) – Enviar el código a través de WhatsApp.
- expiration_date (string, required=False) – Fecha de expiración del código en formato YYYY-MM-DD HH:mm:ss (máximo 3 días desde la creación).
- reset_code (boolean, required=False) – Regenerar el código aunque ya exista uno activo.
- code_type (string, required=False) – Tipo de código a generar (numeric, alphanumeric, letters).
- template (string, required=False) – Plantilla para el mensaje de verificación (a, b, c, etc.).
- reference (boolean, required=False) – Incluir una referencia en la respuesta.
- showcode (integer, required=False) – Mostrar el código en la respuesta (1 para mostrar, 0 para ocultar).
Responses:
- 200: Código generado exitosamente o errores de validación en formato XML
- 400: Validaciones fallidas en formato XML
- 500: Error interno del servidor en formato XML

=== POST /protected/json/phones/verification/check ===
```bash
# Example: POST /protected/json/phones/verification/check
curl -X POST "https://api.smsmasivos.com.mx/protected/json/phones/verification/check" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Verificación del Código enviado
Description: Este endpoint permite validar un código de verificación previamente generado para un número de teléfono específico. Verifica si el código es correcto, si ha expirado, o si se ha excedido el número de intentos permitidos.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono asociado al código de verificación.
- verification_code (string, required=True) – Código de verificación a validar.
- showcode (integer, required=False) – Mostrar el código en la respuesta (1 para mostrar, 0 para ocultar).
Responses:
- 200: Respuesta con el estado de validación del código.
- 400: Errores de validación o límites excedidos.
- 500: Error interno del servidor.

=== POST /protected/xml/phones/verification/check ===
```bash
# Example: POST /protected/xml/phones/verification/check
curl -X POST "https://api.smsmasivos.com.mx/protected/xml/phones/verification/check" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Verificación de Código enviado en Formato XML
Description: Este endpoint valida un código de verificación previamente generado para un número de teléfono específico. Retorna la respuesta en formato XML indicando si el código es válido, ha expirado o si el usuario ya está verificado.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono asociado al código de verificación.
- verification_code (string, required=True) – Código de verificación a validar.
- showcode (integer, required=False) – Mostrar el código en la respuesta (1 para mostrar, 0 para ocultar).
Responses:
- 200: Respuesta con el estado de validación del código en formato XML.

=== POST /protected/json/phones/verification/resend ===
```bash
# Example: POST /protected/json/phones/verification/resend
curl -X POST "https://api.smsmasivos.com.mx/protected/json/phones/verification/resend" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Reenvío de Código de Verificación
Description: Este endpoint permite reenviar un código de verificación previamente generado para un número de teléfono asociado. Puede reenviar el código por SMS, llamada de voz o WhatsApp, dependiendo de los parámetros proporcionados. También permite regenerar un nuevo código si se solicita.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono al que se debe reenviar el código de verificación.
- country_code (string, required=True) – Código de país del número de teléfono.
- showcode (integer, required=False) – Indica si el código debe mostrarse en la respuesta (1 para mostrar, 0 para ocultar).
- reset_code (boolean, required=False) – Indica si debe generarse un nuevo código (true o false).
- voice (boolean, required=False) – Indica si el código debe ser reenviado por llamada de voz (true o false).
- whatsapp (boolean, required=False) – Indica si el código debe ser reenviado por WhatsApp (true o false).
- expiration_date (string, required=False) – Fecha de expiración personalizada para el código en formato YYYY-MM-DD HH:MM:SS.
Responses:
- 200: Respuestas relacionadas con el estado del reenvío del código de verificación.

=== POST /protected/xml/phones/verification/resend ===
```bash
# Example: POST /protected/xml/phones/verification/resend
curl -X POST "https://api.smsmasivos.com.mx/protected/xml/phones/verification/resend" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Reenvío de Código de Verificación en Formato XML
Description: Este endpoint permite reenviar un código de verificación previamente generado para un número de teléfono asociado. Puede reenviar el código por SMS, llamada de voz o WhatsApp, dependiendo de los parámetros proporcionados. También permite regenerar un nuevo código si se solicita. La respuesta es proporcionada en formato XML.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono al que se debe reenviar el código de verificación.
- country_code (string, required=True) – Código de país del número de teléfono.
- showcode (integer, required=False) – Indica si el código debe mostrarse en la respuesta (1 para mostrar, 0 para ocultar).
- reset_code (boolean, required=False) – Indica si debe generarse un nuevo código (true o false).
- voice (boolean, required=False) – Indica si el código debe ser reenviado por llamada de voz (true o false).
- whatsapp (boolean, required=False) – Indica si el código debe ser reenviado por WhatsApp (true o false).
- expiration_date (string, required=False) – Fecha de expiración personalizada para el código en formato YYYY-MM-DD HH:MM:SS.
Responses:
- 200: Respuestas relacionadas con el estado del reenvío del código de verificación en formato XML.

=== POST /protected/json/phones/verification/reset ===
```bash
# Example: POST /protected/json/phones/verification/reset
curl -X POST "https://api.smsmasivos.com.mx/protected/json/phones/verification/reset" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Restablecimiento de Código de Verificación
Description: Este endpoint permite restablecer el estado de un código de verificación para un usuario específico. Puede generar un nuevo código o reutilizar el existente, reiniciando los intentos y el estado del proceso de verificación.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono del usuario para el cual se restablecerá el código.
- country_code (string, required=True) – Código de país del número de teléfono.
- showcode (integer, required=False) – Indica si el código debe mostrarse en la respuesta (1 para mostrar, 0 para ocultar).
- reset_code (boolean, required=False) – Indica si debe generarse un nuevo código (true o false).
- code_type (string, required=False) – Tipo de código a generar (alphanumeric, numeric, o letters).
Responses:
- 200: Respuestas relacionadas con el restablecimiento del código de verificación.

=== POST /protected/xml/phones/verification/reset ===
```bash
# Example: POST /protected/xml/phones/verification/reset
curl -X POST "https://api.smsmasivos.com.mx/protected/xml/phones/verification/reset" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Verification 2FA
Summary: Restablecimiento de Código de Verificación en Formato XML
Description: Este endpoint permite restablecer el estado de un código de verificación para un usuario específico. Puede generar un nuevo código o reutilizar el existente, reiniciando los intentos y el estado del proceso de verificación. La respuesta es devuelta en formato XML.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- phone_number (string, required=True) – Número de teléfono del usuario para el cual se restablecerá el código.
- country_code (string, required=True) – Código de país del número de teléfono.
- showcode (integer, required=False) – Indica si el código debe mostrarse en la respuesta (1 para mostrar, 0 para ocultar).
- reset_code (boolean, required=False) – Indica si debe generarse un nuevo código (true o false).
- code_type (string, required=False) – Tipo de código a generar (alphanumeric, numeric, o letters).
Responses:
- 200: Respuestas relacionadas con el restablecimiento del código de verificación.

=== POST /manager/subaccount/add ===
```bash
# Example: POST /manager/subaccount/add
curl -X POST "https://api.smsmasivos.com.mx/manager/subaccount/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Manager
Summary: Crear Subcuenta de Usuario
Description: Este endpoint permite crear una nueva subcuenta asociada a un usuario principal. La subcuenta incluye detalles como correo electrónico, contraseña, nombre y número de teléfono. Verifica que los datos sean válidos y que no existan conflictos con usuarios ya registrados.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- email (string, required=True) – Correo electrónico para la nueva subcuenta.
- password (string, required=True) – Contraseña para la nueva subcuenta (mínimo 6 caracteres, máximo 36).
- name (string, required=True) – Nombre del usuario para la nueva subcuenta (máximo 250 caracteres).
- number (string, required=True) – Número de teléfono de la nueva subcuenta (mínimo 10 dígitos).
Responses:
- 200: Respuestas relacionadas con la creación de subcuentas.

=== POST /manager/subaccount/archive ===
```bash
# Example: POST /manager/subaccount/archive
curl -X POST "https://api.smsmasivos.com.mx/manager/subaccount/archive" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Manager
Summary: Archivar Subcuenta de Usuario
Description: Este endpoint permite desactivar o archivar una subcuenta asociada a un usuario principal. Verifica que la subcuenta exista, que pertenezca al usuario que realiza la acción y que esté activa antes de proceder con la actualización del estado.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- email (string, required=True) – Correo electrónico de la subcuenta a archivar.
Responses:
- 200: Respuestas relacionadas con la acción de archivar subcuentas.

=== POST /manager/subaccount/get_apikey ===
```bash
# Example: POST /manager/subaccount/get_apikey
curl -X POST "https://api.smsmasivos.com.mx/manager/subaccount/get_apikey" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Manager
Summary: Obtener API Key de Subcuenta
Description: Este endpoint permite recuperar la clave API (API Key) de una subcuenta específica asociada a un usuario principal. Se valida que el correo electrónico proporcionado pertenezca a una subcuenta activa asociada al usuario principal.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- email (string, required=True) – Correo electrónico de la subcuenta cuya API Key se desea recuperar.
Responses:
- 200: Respuestas relacionadas con la recuperación de la API Key de subcuentas.

=== POST /manager/subaccount/credits/manage ===
```bash
# Example: POST /manager/subaccount/credits/manage
curl -X POST "https://api.smsmasivos.com.mx/manager/subaccount/credits/manage" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Manager
Summary: Gestión de Créditos para Subcuentas
Description: Este endpoint permite al usuario principal gestionar los créditos de sus subcuentas asociadas. Las operaciones incluyen agregar o retirar créditos de una subcuenta específica según la dirección indicada por el parámetro **type** (1 para agregar, 2 para retirar).
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- email (string, required=True) – Correo electrónico de la subcuenta.
- type (integer, required=True) – Tipo de operación 1 (agregar créditos), 2 (retirar créditos).
- credits (integer, required=True) – Cantidad de créditos a gestionar (entero positivo).
Responses:
- 200: Respuestas relacionadas con la gestión de créditos de subcuentas.

=== POST /wallet/get ===
```bash
# Example: POST /wallet/get
curl -X POST "https://api.smsmasivos.com.mx/wallet/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Wallet
Summary: Obtener Lista de Monederos del Usuario
Description: Este endpoint devuelve una lista de monederos asociados al usuario autenticado. Incluye información clave como el nombre del monedero, su identificador único y las URLs para el cliente y administrador de la aplicación.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- UsuarioId (integer, required=True) – Identificador único del usuario. (Autenticación interna)
Responses:
- 200: Respuestas relacionadas con los monederos del usuario.

=== POST /wallet/contact/add ===
```bash
# Example: POST /wallet/contact/add
curl -X POST "https://api.smsmasivos.com.mx/wallet/contact/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Wallet
Summary: Agregar Contacto a Monedero
Description: Este endpoint permite agregar un contacto a un monedero específico, proporcionando detalles como nombre, teléfono y fecha de nacimiento del cliente. La operación valida la existencia del monedero y verifica los parámetros antes de enviar la solicitud al servicio correspondiente.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- wallet_key (string, required=True) – Clave única que identifica el monedero.
- phone (string, required=True) – Número de teléfono del contacto (debe ser numérico y tener 10 dígitos).
- customer_name (string, required=True) – Nombre del cliente asociado al contacto.
- customer_birthdate (string, required=False) – Fecha de nacimiento del cliente (opcional).
- usertool_id (integer, required=True) – Identificador único del usuario o herramienta asociada.
Responses:
- 200: Respuestas relacionadas con el contacto agregado.

=== POST /wallet/contact/get ===
```bash
# Example: POST /wallet/contact/get
curl -X POST "https://api.smsmasivos.com.mx/wallet/contact/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Wallet
Summary: Obtener Saldo de Contacto en Monedero
Description: Este endpoint permite consultar el saldo de un monedero o de un contacto registrado en un monedero específico. Requiere validar la existencia del monedero y, opcionalmente, del contacto en el monedero.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- wallet_key (string, required=True) – Clave única que identifica el monedero.
- phone (string, required=False) – Número de teléfono del contacto asociado (opcional).
Responses:
- 200: Respuestas relacionadas con el saldo consultado.

=== POST /wallet/balance/update ===
```bash
# Example: POST /wallet/balance/update
curl -X POST "https://api.smsmasivos.com.mx/wallet/balance/update" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Wallet
Summary: Actualizar Saldo de Contacto en Monedero
Description: Este endpoint permite actualizar el saldo de un contacto registrado en un monedero. La transacción puede ser un incremento o decremento de saldo, y requiere validar tanto el monedero como el contacto y los permisos del usuario.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- wallet_key (string, required=True) – Clave única que identifica el monedero.
- phone (string, required=True) – Número de teléfono del contacto asociado.
- transaction_type (integer, required=True) – Tipo de transacción (0 disminuir saldo, 1 incrementar saldo).
- transaction_amount (number, required=True) – Monto de la transacción.
- usertool_id (integer, required=True) – ID del usuario que realiza la transacción.
Responses:
- 200: Respuestas relacionadas con la actualización del saldo.

=== POST /wallet/sale ===
```bash
# Example: POST /wallet/sale
curl -X POST "https://api.smsmasivos.com.mx/wallet/sale" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Wallet
Summary: Nueva Venta en Monedero Digital
Description: Este endpoint permite registrar una nueva venta asociada a un contacto de un monedero digital. Incluye soporte para transacciones con puntos o monto de conversión y puede requerir la validación de un ticket en caso de que el monedero lo solicite.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- wallet_key (string, required=True) – Clave única que identifica el monedero.
- phone (string, required=True) – Número de teléfono del contacto asociado.
- transaction_type (integer, required=True) – Tipo de transacción (0 Redención, 1 Compra).
- transaction_amount (number, required=False) – Monto de la transacción (obligatorio si es una compra).
- points_used (integer, required=False) – Puntos utilizados en la transacción (obligatorio si es redención).
- ticket (string, required=False) – Código del ticket (si el monedero lo requiere).
- usertool_id (integer, required=True) – ID del usuario que realiza la transacción.
Responses:
- 200: Respuestas relacionadas con el registro de una nueva venta.

=== POST /loyalty/get ===
```bash
# Example: POST /loyalty/get
curl -X POST "https://api.smsmasivos.com.mx/loyalty/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Loyalty Card
Summary: Obtener Tarjetas de Lealtad
Description: Este endpoint permite al usuario obtener una lista de todas las tarjetas de lealtad activas asociadas a su cuenta. Las tarjetas de lealtad devueltas incluyen información clave como nombre, hash único y URLs para la aplicación del cliente y la validación de redenciones.
Headers:
- apikey: string (required) – Tu API key.
Responses:
- 200: Respuestas relacionadas con las tarjetas de lealtad.

=== POST /loyalty/contact/add ===
```bash
# Example: POST /loyalty/contact/add
curl -X POST "https://api.smsmasivos.com.mx/loyalty/contact/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Loyalty Card
Summary: Agregar Contacto a Tarjeta de Lealtad
Description: Este endpoint permite registrar un nuevo contacto en una tarjeta de lealtad específica asociada al usuario. Valida el acceso del usuario, la existencia de la tarjeta, y la información del contacto antes de crear la relación entre el contacto y la tarjeta de lealtad. Además, puede enviar un mensaje de bienvenida al contacto registrado.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- loyalty_key (string, required=False) – Hash único que identifica la tarjeta de lealtad.
- phone (string, required=False) – Número telefónico del contacto, debe tener 10 dígitos.
- customer_name (string, required=False) – Nombre del contacto a registrar.
- customer_birthdate (string, required=False) – Fecha de nacimiento del contacto en formato YYYY-MM-DD (si aplica).
- usertool_id (integer, required=False) – ID de la herramienta asociada al usuario.
Responses:
- 200: Respuestas relacionadas con la operación de agregar contactos a una tarjeta de lealtad.

=== POST /loyalty/contact/get ===
```bash
# Example: POST /loyalty/contact/get
curl -X POST "https://api.smsmasivos.com.mx/loyalty/contact/get" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Loyalty Card
Summary: Obtener Contactos de Tarjeta de Lealtad
Description: Este endpoint permite recuperar información de contactos registrados en una tarjeta de lealtad específica asociada al usuario. Si se proporciona un número de teléfono, devuelve los detalles de ese contacto en particular. En caso contrario, devuelve la lista completa de contactos vinculados a la tarjeta.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- loyalty_key (string, required=False) – Hash único que identifica la tarjeta de lealtad.
- phone (string, required=False) – Número telefónico del contacto, debe tener 10 dígitos (para filtrar un contacto específico).
Responses:
- 200: Respuestas relacionadas con la consulta de contactos de tarjetas de lealtad.

=== POST /loyalty/sale ===
```bash
# Example: POST /loyalty/sale
curl -X POST "https://api.smsmasivos.com.mx/loyalty/sale" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Tool Loyalty Card
Summary: Registrar Nueva Venta en Tarjeta de Lealtad
Description: Este endpoint permite registrar una nueva venta asociada a una tarjeta de lealtad y un cliente específico. Valida el estado de la tarjeta y el cliente, y realiza actualizaciones en el histórico de la tarjeta de lealtad, gestionando posibles recompensas, límites de canjes y envíos de mensajes.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- loyalty_key (string, required=False) – Hash único que identifica la tarjeta de lealtad.
- phone (string, required=False) – Número telefónico del cliente, debe tener 10 dígitos.
- usertool_id (integer, required=False) – Identificador del usuario relacionado con la herramienta.
- transaction_amount (string, required=False) – Monto asociado a la venta (necesario si la tarjeta requiere valor de conversión).
- ticket (string, required=False) – Número de ticket asociado a la venta (necesario si la tarjeta lo requiere).
Responses:
- 200: Respuesta exitosa o errores específicos.

=== POST /employee/add ===
```bash
# Example: POST /employee/add
curl -X POST "https://api.smsmasivos.com.mx/employee/add" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Partners
Summary: Agregar Usuarios de Herramientas
Description: Este endpoint permite agregar un nuevo usuario relacionado con una herramienta específica. Los usuarios pueden ser colaboradores con roles como cajero o gerente. Se requiere información como el nombre del empleado, nombre del negocio, número de contacto, contraseña y tipo de usuario.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- employee_name (string, required=False) – Nombre del empleado que se desea registrar.
- business_name (string, required=False) – Nombre del negocio asociado.
- number (string, required=False) – Número de contacto del usuario (10 dígitos).
- password (string, required=False) – Contraseña para el usuario.
- type (string, required=False) – Tipo de usuario, puede ser "cajero" o "gerente".
Responses:
- 200: Respuesta exitosa o error específico.

=== POST /employee/disable ===
```bash
# Example: POST /employee/disable
curl -X POST "https://api.smsmasivos.com.mx/employee/disable" \
     -H "apikey: $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"key":"value"}'
```
Tags: Partners
Summary: Deshabilitar Usuarios de Herramientas
Description: Este endpoint permite deshabilitar un usuario de herramientas asociado a un número de contacto específico. Una vez deshabilitado, el número de contacto se desvincula del usuario y su estado cambia a inactivo.
Headers:
- apikey: string (required) – Tu API key.
Request JSON body fields:
- number (string, required=False) – Número de contacto del usuario que se desea deshabilitar (10 dígitos).
Responses:
- 200: Respuesta exitosa o error específico.