Recursos y métodos de los SDKs de Omnifox
Los 25 recursos que exponen los SDKs de Node y Python, con los métodos de cada uno y las diferencias de nombre entre ambos lenguajes.
Mira este paso en el video · SDK oficiales: Node, Python y PHP
Ambos SDKs organizan la API en 25 recursos colgados del cliente. La diferencia principal es de estilo: Node usa camelCase y Python snake_case.
Bandeja de entrada
| Recurso | Node | Python |
|---|---|---|
| Contactos | contacts |
contacts |
| Conversaciones | conversations |
conversations |
| Mensajes | messages |
messages |
| Canales | channels |
channels |
| Difusiones | broadcasts |
broadcasts |
| Etiquetas | tags |
tags |
| Respuestas rápidas | snippets |
snippets |
| Campos personalizados | customFields |
custom_fields |
Contactos. list, get, search, create, upsert, update, delete, merge, channels, attachTag/attach_tag, detachTag/detach_tag, attachTagsByName/attach_tags_by_name, detachTagsByName/detach_tags_by_name, openConversation/open_conversation, closeConversation/close_conversation, assignConversation/assign_conversation, setConversationStatus/set_conversation_status, comment. Node añade listPage, listViaDsl, sendMessage, listMessages y getMessage; Python usa list_filtered y deja los mensajes en client.messages.
Conversaciones. list, get, create, assign, close, reopen, addNote/add_note, windowStatus/window_status. En Node además listMessages, sendMessage, getMessage y listPage.
Mensajes. En Node, solo send. En Python, send, list y get.
Canales. list, get, disconnect, health, templates, más create en Node y connect en Python (el nombre cambia).
CRM
| Recurso | Node | Python |
|---|---|---|
| Empresas | companies |
companies |
| Oportunidades | deals |
deals |
| Embudos | pipelines |
pipelines |
| Actividades | crmActivities |
crm_activities |
Oportunidades. list, get, create, update, delete, moveToStage/move_to_stage, close, timeline, board, bulk. La operación masiva actúa sobre hasta 500 oportunidades (reassign, move_stage, close, delete).
Embudos. list, get, create, update, delete, createStage/create_stage, updateStage/update_stage, deleteStage/delete_stage.
Todo el CRM tiene doble candado: el plan necesita el CRM habilitado y el token necesita read:crm o write:crm. Cualquiera de los dos que falte responde 403.
Proyectos y tableros
boards: list, get, view, columns, activity, create, update, delete, duplicate, createGroup/create_group.
boardItems/board_items: create, get, update, delete, duplicate, move, setCellValue/set_cell_value, listUpdates/list_updates, addUpdate/add_update.
Dos detalles que ahorran tiempo: los elementos se direccionan en una URL plana, /boards/items/{id}, no anidados bajo su tablero; y al crear un grupo el campo se llama name, no title. Al escribir una celda, el valor se valida contra el tipo de la columna, y una cadena vacía la limpia.
Agenda, catálogo y ventas
appointments: listCalendars/list_calendars, listServices/list_services, slots, list, book, update, cancel. Un horario ya ocupado responde 409, y pasar starts_at en update reagenda y vuelve a correr el control de choques.
products: list, get, create, update, delete.
orders: list, get, create, update, setStatus/set_status, recordPayment/record_payment, delete. Los estados válidos son pending, confirmed, preparing, ready, shipped, delivered y cancelled; una transición ilegal responde 422 en vez de no hacer nada.
catalogSettings/catalog_settings: get, update, applyPreset/apply_preset.
quotes: list, get, create, update, delete, send, markViewed/mark_viewed, accept, reject, pdf, billingEntities/billing_entities. Enviar la cotización es lo que activa su enlace público, así que el enlace de un borrador nunca resuelve. El método pdf devuelve bytes, no JSON.
El catálogo es transversal: no depende del candado de plan del CRM.
Automatización e infraestructura
workflows: list, get, activate, deactivate, trigger.
webhooks: list, get, create, update, delete, rotateSecret/rotate_secret.
teams: list, get, create, update, delete, addMember/add_member, removeMember/remove_member.
workspaces: list, get, create, update, delete.
users (en Python también accesible como agents): me, logout, más listAgents/getAgent/setAgentStatus en Node y list/get/update_status en Python.
reports: overview, conversations, agents, heatmap, crmFunnel/crm_funnel, crmForecast/crm_forecast, crmWinLossReasons/crm_win_loss_reasons. Todos aceptan un rango; el preset gana sobre las fechas sueltas y, si no pones nada, son los últimos 30 días.
Consejos
- Para cerrar una oportunidad, el embudo necesita una etapa marcada como ganada o perdida; si no existe, el servidor responde
422. - Las difusiones están limitadas por plan: un plan sin difusiones responde
403.
Artículos relacionados
Artículos relacionados
-
Cómo conectar integraciones y apps externas
Conecta Omnifox con tus herramientas favoritas desde el catálogo de integraciones en pocos pasos.
-
Guía completa de integraciones y API
Integraciones y API a fondo, en 30 capítulos: claves API, llamadas reales, webhooks firmados, n8n, MCP y SDK, todo funcionando de verdad.
-
Integrar Omnifox con Azur, Siigo, Alegra, QuickBooks u otro sistema contable o ERP
Omnifox no tiene hoy un conector nativo con sistemas contables o ERP. Te explicamos cómo conectarlos igual con workflows, el nodo HTTP, n8n, Make, Zapier o la API, con ejemplos.
-
Generar y usar API keys y webhooks
Crea claves de API para acceder a Omnifox por código y configura webhooks para recibir eventos en tiempo real.
-
Introducción a las integraciones (webhook / OAuth / API key)
Conecta Omnifox con tus otras herramientas: qué está disponible hoy, qué llega pronto y cuándo usar un webhook, una conexión OAuth o una clave de API.