Skip to content

Mones (6.0.1)

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

Buscar um comando de um diálogo pelo ID do comando, do diálogo e do workspace

Request

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.

Security
x-api-key
Path
workspaceIdinteger(int64)required

Identificador do workspace

dialogIdinteger(int64)required

Identificador do diálogo

dialogActionIdinteger(int64)required

Identificador do comando

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/dialog/action/{workspaceId}/{dialogId}/{dialogActionId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Comando encontrado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
namestring
Example: "Comando 1"
slugstring
Example: "00000a000a0000bb0cc0d0000000000"
statusinteger(int32)
Example: 1
typeinteger(int32)
Example: 1
typeDialogActioninteger(int32)
Example: 1
typeNamestring
Example: "MONES"
orderinteger(int32)
Example: 1
totalIntentsinteger(int32)
Example: 1
totalResponsesinteger(int32)
Example: 1
hasApiboolean
Example: false
hasGoToboolean
Example: false
functioninteger(int32)
Example: 1
functionNamestring
Example: "NONE"
systemboolean
Example: false
dialogActionConditioninteger(int32)
Example: 1
escalationEmailstring
Example: "example@example.com"
escalationSubjectstring
Example: "Assunto do e-mail"
actionResponsesArray of objects(ActionMonesResponse)
apiobject(ApiResponse)
actionIntentsArray of objects(ActionIntentResponse)
dialogActionGroupingobject(DialogActionGroupingResponse)
gotoDialogActionobject(DialogActionResponse)Recursive
dialogobject(DialogResponse)
dialogActionEntitiesArray of objects(DialogActionEntityResponse)
actionReminderobject(ActionReminderResponse)
confirmationPhoneTimesinteger(int32)
Example: 1
confPhoneInvalidActionobject(DialogActionResponse)Recursive
confPhoneValidActionobject(DialogActionResponse)Recursive
confirmationMenuboolean
Example: false
showParameterFilterboolean
Example: false
dialogActionDigitboolean
Example: false
transferToHumanboolean
Example: false
emojiProhibitedstring
Example: "?"
escalationQuantityHistoryinteger(int32)
Example: 1
checkDiscoveryboolean
Example: false
serviceNowobject(ServiceNowResponse)
transferToHumanTypeinteger(int32)
Example: 1
dialogActionFinishAttendantobject(DialogActionResponse)Recursive
menuTypestring
Enum"0""1""2"
Example: "TEXT_OPTIONS"
tentativesBlockDialogActionobject(DialogActionResponse)Recursive
numberTentativesBlockinteger(int32)
Example: 1
automaticBlockboolean
Example: false
removeResponseApiboolean
Example: false
timesToAnythingElseinteger(int32)
Example: 1
dialogActionTimesToAnythingElseobject(DialogActionResponse)Recursive
quizobject(QuizResponse)
dialogActionAfterLastReminderobject(DialogActionResponse)Recursive
fillAllEntitiesOnBlockboolean
Example: false
apiJumpTosArray of objects(ApiJumpToResponse)
omotorHelpdeskobject(OmotorHelpdeskResponse)
monesEntityTransferToHumanobject(MonesEntityResponse)
genesysobject(GenesysResponse)
genesysLikeWaterobject(GenesysLikeWaterResponse)
saveFilesWhenNewsletterboolean
Example: false
Response
application/json
{
  "data": {
    "dialogAction": { … }
  }
}

Buscar todos os comandos de um diálogo

Request

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.

Security
x-api-key
Path
dialogIdinteger(int64)required

Identificador do diálogo

workspaceIdinteger(int64)required

Identificador do workspace

Query
namestring

Nome do comando

typeinteger(int32)

Identificador do tipo de comando, com os valores possíveis:

  • 0: NONE
  • 1: USER
  • 2: MONES
  • 3: ATTENDANT
groupinginteger(int64)

Identificador do grupo de comandos

reminderboolean

Indica se o comando é um lembrete

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/dialog/action/{dialogId}/{workspaceId}?name=string&type=0&grouping=0&reminder=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Comandos encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
namestring
Example: "Comando 1"
slugstring
Example: "00000a000a0000bb0cc0d0000000000"
statusinteger(int32)
Example: 1
typeinteger(int32)
Example: 1
typeDialogActioninteger(int32)
Example: 1
typeNamestring
Example: "MONES"
orderinteger(int32)
Example: 1
totalIntentsinteger(int32)
Example: 1
totalResponsesinteger(int32)
Example: 1
hasApiboolean
Example: false
hasGoToboolean
Example: false
functioninteger(int32)
Example: 1
functionNamestring
Example: "NONE"
systemboolean
Example: false
dialogActionConditioninteger(int32)
Example: 1
escalationEmailstring
Example: "example@example.com"
escalationSubjectstring
Example: "Assunto do e-mail"
actionResponsesArray of objects(ActionMonesResponse)
apiobject(ApiResponse)
actionIntentsArray of objects(ActionIntentResponse)
dialogActionGroupingobject(DialogActionGroupingResponse)
gotoDialogActionobject(DialogActionResponse)Recursive
dialogobject(DialogResponse)
dialogActionEntitiesArray of objects(DialogActionEntityResponse)
actionReminderobject(ActionReminderResponse)
confirmationPhoneTimesinteger(int32)
Example: 1
confPhoneInvalidActionobject(DialogActionResponse)Recursive
confPhoneValidActionobject(DialogActionResponse)Recursive
confirmationMenuboolean
Example: false
showParameterFilterboolean
Example: false
dialogActionDigitboolean
Example: false
transferToHumanboolean
Example: false
emojiProhibitedstring
Example: "?"
escalationQuantityHistoryinteger(int32)
Example: 1
checkDiscoveryboolean
Example: false
serviceNowobject(ServiceNowResponse)
transferToHumanTypeinteger(int32)
Example: 1
dialogActionFinishAttendantobject(DialogActionResponse)Recursive
menuTypestring
Enum"0""1""2"
Example: "TEXT_OPTIONS"
tentativesBlockDialogActionobject(DialogActionResponse)Recursive
numberTentativesBlockinteger(int32)
Example: 1
automaticBlockboolean
Example: false
removeResponseApiboolean
Example: false
timesToAnythingElseinteger(int32)
Example: 1
dialogActionTimesToAnythingElseobject(DialogActionResponse)Recursive
quizobject(QuizResponse)
dialogActionAfterLastReminderobject(DialogActionResponse)Recursive
fillAllEntitiesOnBlockboolean
Example: false
apiJumpTosArray of objects(ApiJumpToResponse)
omotorHelpdeskobject(OmotorHelpdeskResponse)
monesEntityTransferToHumanobject(MonesEntityResponse)
genesysobject(GenesysResponse)
genesysLikeWaterobject(GenesysLikeWaterResponse)
saveFilesWhenNewsletterboolean
Example: false
Response
application/json
{
  "data": {
    "dialogActions": [ … ]
  }
}

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

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