Skip to content

Mones (6.0.0)

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.
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.omotor.com.br/_mock/openapi/

https://api-dev.omotor.com.br/

https://api-prod.omotor.com.br/

Integração de Contato

Gerencie contatos e seus atributos diretamente via API.

Operations

Integração de Entidade

Listagem de entidades atribuídas a um contato diretamente via API.

Operations

Integração de Envio de Mensagem

Gerencie o envio de mensagens para usuários via API.

Operations

Enviar mensagem direta para um usuário

Request

Envia uma mensagem direta para um usuário específico, utilizando os dados da conversa enviadas na requisição.

Security
x-api-key
Path
tokenstringrequired

Token

Bodyapplication/jsonrequired

Dados da mensagem a ser enviada

userIdentifystringrequired

Identificador do destinatário.

  • Utilize o número no formato DDI+DDD+Número, sem espaços, parênteses ou hífens.
Example: "5511912345678"
monesConversationSlugstringrequired

Identificador da conversa Mones onde a mensagem será enviada.

Example: "00000a000a0000bb0cc0d0000000000"
actionsArray of objects(NewsletterDetail)required

Payload com o conteúdo da mensagem a ser enviada.

actions[].​newsletterDetailTextsArray of objects(NewsletterDetailText)required

Payload com o conteúdo textual da mensagem a ser enviada.

actions[].​newsletterDetailTexts[].​textstring

Texto a ser enviado.

Example: "Olá, mundo"
actions[].​newsletterDetailTexts[].​entityIdinteger(int64)

Identificador da entidade a ser associada à mensagem.

  • Preencha apenas se desejar incluir uma entidade no envio.
Example: 1
actions[].​newsletterDetailTexts[].​orderinteger(int32)

Ordem de exibição do texto na mensagem.

Example: 1
actions[].​orderinteger(int32)

Ordem de exibição do conteúdo na mensagem.

Example: 1
actions[].​pathstring

Link do arquivo a ser enviado.

Example: "exemplo.com/arquivo.pdf"
actions[].​fileNamestring

Nome do arquivo a ser enviado.

Example: "Arquivo"
actions[].​fileSizeinteger(int64)

Tamanho do arquivo a ser enviado.

Example: 1024
actions[].​fileTypestring

Tipo do arquivo a ser enviado. Os valores possíveis são:

  • "DOC": Documento Word (.doc)
  • "DOCX": Documento Word (.docx)
  • "PDF": Documento PDF (.pdf)
  • "PPT": Apresentação PowerPoint (.ppt)
  • "PPTX": Apresentação PowerPoint (.pptx)
  • "XLS": Planilha Excel (.xls)
  • "XLSX": Planilha Excel (.xlsx)
  • "CSV": Planilha CSV (.csv)
  • "TXT": Arquivo de texto (.txt)
  • "JPEG", "JPG": Imagem JPEG
  • "PNG": Imagem PNG
  • "WEBP": Imagem WEBP
  • "MP3", "MP3_2", "MP3_3": Áudio MP3
  • "OGG": Áudio OGG
  • "WAV": Áudio WAV
  • "WEBM": Áudio WEBM
  • "MP4": Vídeo MP4
  • "MSWORD", "MSEXCEL", "MSPOWERPOINT": Formatos Microsoft Office específicos
  • "OFFICEDOCUMENT", "SHEET", "DOCUMENT", "PRESENTATION": Formatos Office abertos
  • "FILE": Arquivo genérico
  • "NONE": Nenhum arquivo
Enum"none""doc""docx""pdf""ppt""jpeg""mp3""mp4""xls""xlsx"
Example: "PDF"
functionstring

Tipo de função a ser aplicada na mensagem. Os valores possíveis são:

  • "0": NONE — Nenhuma função aplicada.
  • "1": GOTO — Redireciona o fluxo da conversa para outro ponto.
  • "2": STOP — Interrompe o fluxo atual da conversa.
  • "3": COGNITION — Realiza uma etapa de cognição ou decisão no fluxo.
  • "4": MENU — Exibe um menu de opções para o usuário.
  • "5": ASK — Realiza uma pergunta ao usuário e espera uma resposta.
  • "6": ESCALATION — Escala o atendimento para um humano.
  • "7": REMINDER — Envia um lembrete ou notificação programada.
  • "8": CONTEXT — Injeta ou manipula contexto na conversa.
  • "9": QUIZ — Apresenta um questionário ou quiz ao usuário.
Enum"0""1""2""3""4""5""6""7""8""9"
Example: "0"
menuTypestring

Tipo de apresentação das opções de menu na mensagem. Os valores possíveis são:

  • "0": REMOVE_OPTIONS — Remove completamente as opções de menu existentes.
  • "1": TEXT_OPTIONS — Exibe as opções no formato de texto.
  • "2": BUTTON_OPTIONS — Exibe as opções no formato de botões clicáveis.
Enum"0""1""2"
Example: "0"
ignoreMenuBlockboolean

Indica se a mensagem deve ignorar os bloqueios configurados para apresentação de menu.

Example: false
dialogActionSlugBlockstring

Identificador do comando Mones que deve ser ativado como bloqueio ao usuário.

Após o envio da mensagem, qualquer resposta do usuário será redirecionada pare esse comando.

Example: "00000a000a0000bb0cc0d0000000000"
curl -i -X POST \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/message/{token}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "userIdentify": "string",
    "monesConversationSlug": "string",
    "actions": [
      {
        "newsletterDetailTexts": [
          {
            "text": "string",
            "entityId": 0,
            "order": 0
          }
        ],
        "order": 0,
        "path": "string",
        "fileName": "string",
        "fileSize": 0,
        "fileType": "string"
      }
    ],
    "function": "string",
    "menuType": "string",
    "ignoreMenuBlock": false,
    "dialogActionSlugBlock": "string"
  }'

Responses

Mensagem enviada com sucesso

Bodyapplication/json
Response
application/json
{}

Enviar mensagem para um usuário (HSM, SMS, E-mail ou Direta)

Request

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.

Security
x-api-key
Path
conversationSlugstringrequired

Identificador da conversa

Bodyapplication/jsonrequired

Dados da mensagem a ser enviado

typestringrequired

Tipo de mensagem a ser enviada. Os valores possíveis são:

  • "HSM": Mensagem por WhatsApp no formato HSM (modelo aprovado).
  • "SMS": Mensagem de texto via SMS.
  • "EMAIL": Mensagem enviada por e-mail.
  • "DIRECT_MSG": Mensagem direta enviada por canal específico da conversa.
Enum"HSM""SMS""EMAIL""DIRECT_MSG"
Example: "HSM"
emailstring

E-mail do destinatário.

Example: "johndoe@email.com"
phoneinteger(int64)

Telefone do destinatário.

  • Utilize o número no formato DDI+DDD+Número, sem espaços, parênteses ou hífens.
Example: 5511912345678
firstNamestring[ 0 .. 45 ] charactersrequired

Nome do destinatário.

Example: "John"
lastNamestring[ 0 .. 45 ] characters

Sobrenome do destinatário.

Example: "Doe"
subjectstring

Assunto do e-mail.

Example: "Assunto Urgente"
messagestring

Texto da mensagem.

Example: "Olá, mundo"
attachmentstring

Anexo do e-mail.

Example: "exemplo.com/arquivo.pdf"
hsmstring

Nome do template HSM.

Example: "template-hsm"
hsmParamsArray of objects(GenericWappParam)

Lista de parâmetros do template HSM.

dialogActionSlugBlockstring

Identificador do comando Mones que deve ser ativado como bloqueio ao usuário.

Após o envio da mensagem, qualquer resposta do usuário será redirecionada pare esse comando.

Example: "00000a000a0000bb0cc0d0000000000"
linkstring

Link a ser enviado com a mensagem.

Example: "https://exemplo.com"
monesConversationSlugstring

Identificador da conversa Mones.

Example: "00000a000a0000bb0cc0d0000000000"
emailFromstring

E-mail do remetente.

Example: "janedoe@email.com"
emailPersonalstring

Nome/Razão social do remetente.

Example: "Jane Doe"
emailTemplatestring

Nome do template de e-mail.

Example: "template-email"
directMessageobject(DirectMessageRequest)

Payload da mensagem direta a ser enviada.

completedMessagestring
curl -i -X POST \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/message/generic/{conversationSlug}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "type": "HSM",
    "firstName": "string",
    "lastName": "string",
    "phone": 0,
    "hsm": "string",
    "hsmParams": [
      {
        "position": 1,
        "value": "string",
        "link": false
      }
    ]
  }'

Responses

Mensagem enviada com sucesso

Bodyapplication/json
Response
application/json
{}

Integração de Envio de Mensagem com Personalização

Envie mensagens enriquecidas para usuários via API, com suporte a personalização de contatos.

Operations

Integração de Grupo de Comandos

Listagem de grupos de comandos diretamente via API.

Operations

Integração de Registro de Bot de Conversa (CBR)

Listagem de registros de relacionamento bot-contato em conversas diretamente via API.

Operations

Integração de Template WhatsApp

Listagem dos templates disponíveis para o provider WhatsApp diretamente via API.

Operations