Skip to main content

Official Python SDK for DoJa Chatbots and WhatsApp Business Integration

Project description

DoJa Python SDK 🚀

El DoJa SDK es la librería principal de Python para conectar, automatizar y escalar plataformas de mensajería usando la API Cloud Oficial de WhatsApp (Meta). Facilita la construcción de flujos de atención al cliente, notificaciones transaccionales y catálogos en minutos sin lidiar con los complejos requerimientos de configuración nativos.

Nota: El uso de este SDK está protegido. Requieres una licencia oficial expedida por DoJa Consulting para interactuar con los servidores mediante esta capa.


💻 Instalación

Solo requieres Python 3.7+ y pip:

pip install doja-sdk

🛠️ Configuración Rápida (Quickstart)

Para usar la librería, necesitas tu Token de Licencia de DoJa, tu Token Temporal/Permanente de Meta y tu ID del Número de Teléfono (Phone ID).

from doja_sdk import DojaClient, DojaAuthError

try:
    client = DojaClient(
        doja_token="DOJA-SEC-TULICENCIA-AQUI",
        whatsapp_token="EAAB123456789...", 
        phone_id="100747123456"
    )
    print("¡Conexión establecida exitosamente!")
except DojaAuthError as e:
    print(f"Error de validación de licencia: {e}")

💬 Tipos de Mensajes Soportados

Todas las funciones requieren el número de teléfono del destinatario con su código de país (sin el signo + ni espacios). Ejemplo para México: "525512345678".

1. Mensaje de Texto Simple

Envía alertas, recordatorios o notificaciones de texto plano.

client.send_text("525512345678", "¡Hola! Hemos recibido tu solicitud. Un asesor se pondrá en contacto contigo a la brevedad.")

2. Mensaje con Documento (PDF, Excel, etc.)

Ideal para adjuntar facturas, reportes médicos, contratos o recibos de compra mediante enlaces directos (URL).

client.send_document(
    to="525512345678", 
    url="https://tu-dominio.com/factura-1234.pdf", 
    caption="Aquí tienes tu factura del mes 📝", 
    filename="Factura_Octubre.pdf"
)

3. Mensaje con Imagen

Para enviar banners promocionales, catálogos visuales o fotografías de productos.

client.send_image(
    to="525512345678", 
    url="https://tu-dominio.com/promo-verano.jpg", 
    caption="¡Aprovecha nuestro descuento de temporada!"
)

4. Ubicación Compartida (Map Pin 📍)

Permite enviar coordenadas de oficinas, clínicas o sucursales físicas (Abre Maps/Waze nativamente en el móvil).

client.send_location(
    to="525512345678", 
    latitude=19.432608, 
    longitude=-99.133209, 
    name="Oficinas Centrales", 
    address="Centro Histórico, CDMX, México"
)

5. Botones Interactivos (Respuesta Rápida)

Perfectos para encuestas o bifurcaciones de decisiones rápidas (Soporta máximo 3 botones).

botones = [
    {"id": "btn_soporte", "title": "📞 Hablar con Soporte"},
    {"id": "btn_ventas", "title": "🛒 Cotizar Servicios"},
]

client.send_interactive_button(
    to="525512345678", 
    body_text="¡Bienvenido a nuestro canal de atención! ¿En qué área podemos apoyarte hoy?", 
    buttons_list=botones
)

6. Menú Desplegable (Lista Interactiva)

La mejor opción cuando tienes flujos complejos o más de 3 opciones (ej. Menú principal, selección de departamentos o listado de servicios).

secciones = [
    {
        "title": "Áreas de Atención",
        "rows": [
            {"id": "opt_1", "title": "Soporte Técnico", "description": "Fallas o configuraciones"},
            {"id": "opt_2", "title": "Facturación", "description": "Dudas sobre pagos"},
            {"id": "opt_3", "title": "Ventas B2B", "description": "Soluciones empresariales"}
        ]
    }
]

client.send_interactive_list(
    to="525512345678", 
    body_text="Por favor selecciona el departamento con el que deseas comunicarte:", 
    button_text="Ver Opciones", 
    sections=secciones
)

¿Dudas o requerimientos personalizados? | Soporte Oficial: contact@dojaconsulting.cloud

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doja_sdk-0.2.2.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doja_sdk-0.2.2-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file doja_sdk-0.2.2.tar.gz.

File metadata

  • Download URL: doja_sdk-0.2.2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for doja_sdk-0.2.2.tar.gz
Algorithm Hash digest
SHA256 902936b429d773f6eab3d6f3f45801e1c97a2102608561b50556c1c7f03a9620
MD5 efe8ea2654ba352edf825099e4ac398e
BLAKE2b-256 7275af7bcfc756d0530aca53eacb226485c691678b747dc0df486d8ffda68042

See more details on using hashes here.

File details

Details for the file doja_sdk-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: doja_sdk-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for doja_sdk-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e3dc66f18081fcaf783960cc9cab355df0027558a88aa6577c4c250a7fe5dbf0
MD5 f6800d8e6f3761574bea81e6af32c112
BLAKE2b-256 455e63a607d26d6bf79e95b38b8801a5488b1262c96489823ae4ce3623b8c676

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page