Recursos e métodos dos SDKs da Omnifox

Os 25 recursos que os SDKs de Node e Python expõem, com os métodos de cada um e as diferenças de nome entre as duas linguagens.

Aug 19, 2026

Veja este passo no vídeo · SDKs oficiais: Node, Python e PHP

Os dois SDKs organizam a API em 25 recursos pendurados no cliente. A diferença principal é de estilo: Node usa camelCase e Python usa snake_case.

Caixa de entrada

Recurso Node Python
Contatos contacts contacts
Conversas conversations conversations
Mensagens messages messages
Canais channels channels
Transmissões broadcasts broadcasts
Etiquetas tags tags
Respostas rápidas snippets snippets
Campos personalizados customFields custom_fields

Contatos. 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 acrescenta listPage, listViaDsl, sendMessage, listMessages e getMessage; Python usa list_filtered e deixa as mensagens em client.messages.

Conversas. list, get, create, assign, close, reopen, addNote/add_note, windowStatus/window_status. No Node, além disso, listMessages, sendMessage, getMessage e listPage.

Mensagens. No Node, apenas send. No Python, send, list e get.

Canais. list, get, disconnect, health, templates, mais create no Node e connect no Python (o nome muda).

CRM

Recurso Node Python
Empresas companies companies
Oportunidades deals deals
Funis pipelines pipelines
Atividades crmActivities crm_activities

Oportunidades. list, get, create, update, delete, moveToStage/move_to_stage, close, timeline, board, bulk. A operação em massa atua sobre até 500 oportunidades (reassign, move_stage, close, delete).

Funis. list, get, create, update, delete, createStage/create_stage, updateStage/update_stage, deleteStage/delete_stage.

Todo o CRM tem trava dupla: o plano precisa ter o CRM habilitado e o token precisa de read:crm ou write:crm. Se faltar qualquer um dos dois, a resposta é 403.

Projetos e quadros

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.

Dois detalhes que poupam tempo: os itens são endereçados em uma URL plana, /boards/items/{id}, e não aninhados sob o quadro deles; e, ao criar um grupo, o campo se chama name, não title. Ao escrever uma célula, o valor é validado contra o tipo da coluna, e uma string vazia limpa a célula.

Agenda, catálogo e vendas

appointments: listCalendars/list_calendars, listServices/list_services, slots, list, book, update, cancel. Um horário já ocupado responde 409, e passar starts_at em update reagenda e roda de novo o controle de choques.

products: list, get, create, update, delete.

orders: list, get, create, update, setStatus/set_status, recordPayment/record_payment, delete. Os status válidos são pending, confirmed, preparing, ready, shipped, delivered e cancelled; uma transição ilegal responde 422 em vez de simplesmente não fazer 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 o orçamento é o que ativa o link público dele, então o link de um rascunho nunca resolve. O método pdf retorna bytes, não JSON.

O catálogo é transversal: não depende da trava de plano do CRM.

Automação e infraestrutura

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 (no Python também acessível como agents): me, logout, mais listAgents/getAgent/setAgentStatus no Node e list/get/update_status no Python.

reports: overview, conversations, agents, heatmap, crmFunnel/crm_funnel, crmForecast/crm_forecast, crmWinLossReasons/crm_win_loss_reasons. Todos aceitam um intervalo; o preset vence as datas soltas e, se você não informar nada, são os últimos 30 dias.

Dicas

  • Para fechar uma oportunidade, o funil precisa de uma etapa marcada como ganha ou perdida; se não existir, o servidor responde 422.
  • As transmissões são limitadas por plano: um plano sem transmissões responde 403.

Artigos relacionados

Isso foi útil?

Artigos relacionados

Fale conosco no WhatsApp