# Mones **Sobre o Projeto MONES** A **MONES** é uma plataforma inteligente e integrada de IAs especializadas para diferentes áreas da empresa, como RH, Atendimento, Vendas, Jurídico e Logística. Diferente de soluções com bots isolados, a MONES oferece um ecossistema completo com integração multicanal (WhatsApp, Webchat, Instagram, Teams, Telegram), memória conversacional, formulários eletrônicos e central humana integrada — tudo com gestão simples e sem necessidade de conhecimento técnico. **Integrações via API** A plataforma conta com uma API robusta que permite integrações personalizadas com sistemas externos. Como: - **Integração de Contato**: Permite gerenciar informações de contatos nas conversas, como criar, atualizar e deletar, além de trabalhar com atributos personalizados — criando, buscando e atribuindo valores — para enriquecer o perfil de cada usuário e personalizar o atendimento com mais inteligência. - **Integração de Diálogo**: Permite gerenciar diálogos e seus comandos, criando fluxos interativos e automatizados para atendimento personalizado. - **Integração de Entidade**: Lista e consulta entidades associadas a um contato, fornecendo informações relevantes sobre cada usuário. - **Integração de Envio de Mensagem**: Permite enviar mensagens para usuários por diferentes canais de forma personalizada e automatizada. Suporta o envio de mensagens do tipo HSM, SMS, e-mail e mensagem direta, com uso de templates genéricos e estrutura flexível. - **Integração de Envio de Mensagem com Personalização**: Permite enviar mensagens enriquecidas, utilizando atributos de contatos e templates flexíveis para personalizar cada interação. - **Integração de Grupos de Comandos**: Lista grupos de comandos disponíveis via API, facilitando a organização e reutilização de automações. - **Integração de Registro de Bot de Conversa (CBR)**: Permite consultar registros do relacionamento entre bots e contatos nas conversas de forma precisa. - **Integração de Template WhatsApp**: Permite consultar templates do WhatsApp disponíveis, possibilitando a visualização de modelos ativos e aprovados no provedor, com seus respectivos parâmetros, categorias e metadados. Version: 6.0.0 ## Servers ``` https://api-dev.omotor.com.br ``` ``` https://api-prod.omotor.com.br ``` ## Security ### x-api-key Type: apiKey In: header Name: x-api-key ## Download OpenAPI description [Mones](https://docs.omotor.com.br/_spec/openapi.yaml) ## Integração de Contato Gerencie contatos e seus atributos diretamente via API. ### Criar um novo contato sem chave e sem atributos - [POST /v2/integrations/contact/item](https://docs.omotor.com.br/openapi/integracao-de-contato/savecontactitem.md): Permite criar um contato sem chave e sem informações personalizados, somente com informações básicas. ### Criar ou atualizar um contato com suas informações - [POST /v2/integrations/contact/item/key](https://docs.omotor.com.br/openapi/integracao-de-contato/upsertcontactitem.md): Permite criar ou atualizar um contato em uma conversa. A operação executada depende da presença do campo : - : não envie o campo . Para criar um contato, é obrigatório que o workspace tenha um atributo configurado como chave, e que um valor desse atributo seja previamente criado e incluído na lista de valores de atributos da requisição. - : envie o campo com o valor usado na criação para identificar o contato a ser atualizado. Lembrando que o telefone . Também permite incluir valores personalizados já com seus respectivos atributos — como 'São Paulo (Cidade)', 'Vendas (Departamento)', entre outros — além de possibilitar o envio de um atributo de ativação. ### Buscar todos os atributos de contato - [GET /v2/integrations/contact/group](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactgroups.md): Permite buscar a lista de todas as informações personalizadas dos seus contatos para o workspace autenticado. ### Criar um novo atributo de contato - [POST /v2/integrations/contact/group](https://docs.omotor.com.br/openapi/integracao-de-contato/addcontactgroup.md): Cria uma nova categoria de informações para seus contatos. Exemplo: você pode criar um campo chamado 'Setor' para armazenar o setor do cliente. ### Cadastrar um novo valor em um atributo - [POST /v2/integrations/contact/group/value](https://docs.omotor.com.br/openapi/integracao-de-contato/addcontactgroupvalue.md): Adiciona um novo valor dentro de uma categoria. Exemplo: dentro do atributo 'Departamento', cadastrar o valor 'Vendas'. ### Buscar um contatos paginados por filtro - [GET /v2/integrations/contact/item/{workspaceId}/{contactId}/{length}/{currentPage}](https://docs.omotor.com.br/openapi/integracao-de-contato/findcontactitembyfilter.md): Permite buscar contatos em uma lista através de filtros personalizados e paginação. Por exemplo: buscar todos os contatos que possuem o nome 'João' e que possuem o atributo 'Departamento' com o valor 'Vendas'. ### Buscar valores e atributos de um contato pelo ID - [GET /v2/integrations/contact/item/group/value/{contactItemId}](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactitemgroupvaluesbyid.md): Permite buscar a lista de todos os valores e respectivos atributos associados a um contato específico através do ID. Por exmplo: Rio de Janeiro (Estado), Desenvolvedor (Cargo) e Masculino (Sexo). ### Buscar valores e atributos de um contato pelo slug - [GET /v2/integrations/contact/item/group/value/slug/{contactItemSlug}](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactitemgroupvaluesbyslug.md): Permite buscar a lista de todos os valores e respectivos atributos associados a um contato específico através do slug. Por exmplo: Santa Catarina (Estado), QA (Cargo) e Feminino (Sexo). ### Remover registros de bloqueios de um chat - [GET /v2/integrations/contact/item/clean/blocks/{conversationSlug}/{chatId}](https://docs.omotor.com.br/openapi/integracao-de-contato/contactcleanblocks.md): Remove todos os registros de bloqueio associados a um bot específico e a um determinado chat. Essa operação é utilizada para liberar o fluxo de interação, apagando restrições armazenadas: - Bloqueios de redirecionamentos - Bloqueios de menus - Bloqueios de confirmação de telefone - Bloqueios de perguntas - Bloqueios de ativações - Bloqueios de pesquisas ### Buscar um atributo de contato pelo nome - [GET /v2/integrations/contact/group/{contactGroupName}](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactgroupbyname.md): Permite buscar informações personalizadas dos seus contatos, como por exemplo 'Nome', 'Idade', 'Cidade'. ### Buscar todos os valores de um atributo pelo ID - [GET /v2/integrations/contact/group/value/{contactGroupId}](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactgroupvalue.md): Permite buscar a lista de todos os valores cadastrados em uma categoria específica. Exemplo: para o atributo 'Departamento', pode retornar os valores 'Vendas', 'Financeiro' e 'RH' ### Buscar um valor dentro de um atributo - [GET /v2/integrations/contact/group/value/{contactGroupId}/value/{contactGroupValue}](https://docs.omotor.com.br/openapi/integracao-de-contato/getcontactgroupvalue_1.md): Verifica se um determinado valor está cadastrado dentro de uma categoria. Por exemplo: verificar se o valor 'Marketing' existe dentro da categoria 'Setor'. ### Excluir um contato com base em dados informados - [DELETE /v2/integrations/contact/item/{conversationSlug}/key/{key}](https://docs.omotor.com.br/openapi/integracao-de-contato/deletecontactitem.md): Remove um contato a partir do identificador da conversa (slug) e do valor de um atributo definido como identificador no grupo de importação do workspace. Por exemplo: excluir o contato da conversa 'abc123' cujo CPF (valor do atributo definido) seja '00000000000'. ## Integração de Diálogo Gerencie diálogos e seus comandos diretamente via API. ### Buscar um comando de um diálogo pelo ID do comando, do diálogo e do workspace - [GET /v2/integrations/dialog/action/{workspaceId}/{dialogId}/{dialogActionId}](https://docs.omotor.com.br/openapi/integracao-de-dialogo/getdialogactionbydialogidandworkspaceid.md): Permite recuperar um comando específico dentro de um diálogo. Exemplo: no diálogo 'Diálogo 1', buscar o comando 'Esperar a resposta' pelo seu identificador. ### Buscar todos os comandos de um diálogo - [GET /v2/integrations/dialog/action/{dialogId}/{workspaceId}](https://docs.omotor.com.br/openapi/integracao-de-dialogo/get.md): Permite buscar a lista de todos os comandos de um diálogo específico através do identificador do diálogo e do workspace, com suporte a filtros opcionais. ## Integração de Entidade Listagem de entidades atribuídas a um contato diretamente via API. ### Buscar todas as entidades de um contato específico - [GET /v2/integrations/entity/{slugBot}/{userIdentify}](https://docs.omotor.com.br/openapi/integracao-de-entidade/getcontactitementities.md): Retorna a lista de informações que apoiam a compreensão e a condução das interações associadas a um contato específico, como dados coletados em pesquisas de NPS ou informações de contato, obtidas durante a conversa por meio da cognição. ## Integração de Envio de Mensagem Gerencie o envio de mensagens para usuários via API. ### Enviar mensagem direta para um usuário - [POST /v2/integrations/message/{token}](https://docs.omotor.com.br/openapi/integracao-de-envio-de-mensagem/sendmessagedirect.md): Envia uma mensagem direta para um usuário específico, utilizando os dados da conversa enviadas na requisição. ### Enviar mensagem para um usuário (HSM, SMS, E-mail ou Direta) - [POST /v2/integrations/message/generic/{conversationSlug}](https://docs.omotor.com.br/openapi/integracao-de-envio-de-mensagem/sendhsm.md): Envia uma mensagem para um usuário utilizando um template genérico. Suporta os tipos: HSM, SMS, E-mail e Mensagem Direta, definidos no campo 'type' da requisição. ## Integração de Envio de Mensagem com Personalização Envie mensagens enriquecidas para usuários via API, com suporte a personalização de contatos. ### Enviar mensagem personalizada para um usuário - [POST /v2/integrations/custom/message](https://docs.omotor.com.br/openapi/integracao-de-envio-de-mensagem-com-personalizacao/sendmessagedirectcustom.md): Envia uma mensagem para um usuário utilizando um template genérico, com possibilidade de: - Atualizar/criar um contato; - Definir/criar valores e atributos para um contato; - Cancelar lembretes previamente agendados. Suporta os tipos: HSM, SMS, E-mail e Mensagem Direta, definidos no campo 'type' da requisição. ## Integração de Grupo de Comandos Listagem de grupos de comandos diretamente via API. ### Buscar todos grupos de comandos - [GET /v2/integrations/grouping/{workspaceId}/{groupingView}](https://docs.omotor.com.br/openapi/integracao-de-grupo-de-comandos/getgroupings.md): Permite buscar a lista de todos os grupos de comandos disponíveis para o workspace informado. ## Integração de Registro de Bot de Conversa (CBR) Listagem de registros de relacionamento bot-contato em conversas diretamente via API. ### Buscar registro de relacionamento bot-contato - [GET /v2/integrations/cbr/{userIdentify}/{conversationSlug}](https://docs.omotor.com.br/openapi/integracao-de-registro-de-bot-de-conversa-(cbr)/getcbruseridentifyandconversationslug.md): Permite buscar o registro de relacionamento bot-contato através do identificador do contato e da conversa. ## Integração de Template WhatsApp Listagem dos templates disponíveis para o provider WhatsApp diretamente via API. ### Buscar todos os templates WhatsApp ativo - [GET /v2/integrations/template](https://docs.omotor.com.br/openapi/integracao-de-template-whatsapp/findallactivebyworkspace.md): Permite buscar a lista de todos os templates ativos e disponíveis para o workspace autenticado.