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

Criar um novo contato sem chave e sem atributos

Request

Permite criar um contato sem chave e sem informações personalizados, somente com informações básicas.

Security
x-api-key
Bodyapplication/jsonrequired

Dados do contato a ser criado

firstnamestring

Nome do contato.

Example: "John"
lastnamestring

Sobrenome do contato.

Example: "Doe"
ddiinteger(int32)

DDI do contato.

Example: 55
phoneinteger(int64)

Telefone do contato.

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

E-mail do contato.

Example: "johndoe@email.com"
notestring

Notas do contato.

Example: "Este contato possui notas"
contactobject(ContactViewRequest)

Payload da lista de contatos.

curl -i -X POST \
  https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "firstname": "string",
    "lastname": "string",
    "ddi": 0,
    "phone": 0,
    "email": "string",
    "note": "string",
    "contact": {
      "id": 0,
      "workspace": {
        "id": 0
      }
    }
  }'

Responses

Contato criado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
firstnamestring
Example: "John"
lastnamestring
Example: "Doe"
ddiinteger(int32)
Example: 55
phoneinteger(int64)
Example: 5511912345678
emailstring
Example: "johndoe@email.com"
cbrEditorsArray of strings or null or null
Example: ["valor 1","valor 2"]
notestring or null
Example: "Este contato possui notas"
slugstring
Example: "00000a000a0000bb0cc0d0000000000"
contactItemGroupValueArray of objects(ContactItemGroupValueResponse)
confirmOptinResponseArray of objects(ConfirmOptinResponse)
Response
application/json
{
  "data": {
    "contact": { … }
  }
}

Criar ou atualizar um contato com suas informações

Request

Permite criar ou atualizar um contato em uma conversa. A operação executada depende da presença do campo key:

  • Criação: não envie o campo key. 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.
  • Atualização: envie o campo key com o valor usado na criação para identificar o contato a ser atualizado. Lembrando que o telefone não pode ser alterado.

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.

Security
x-api-key
Bodyapplication/jsonrequired

Dados do contato a ser criado ou atualizado

keystring

Chave de identificação do contato. Deve conter o valor do atributo configurado como chave no workspace.

  • Não deve ser enviado na criação.
  • Obrigatório na atualização para localizar o contato.
Example: "11122233344"
firstnamestring

Nome do contato.

Example: "John"
lastnamestring

Sobrenome do contato.

Example: "Doe"
ddiinteger(int32)

DDI do telefone do contato.

Example: 55
phoneinteger(int64)

Número de telefone do contato.

Example: 11912345678
emailstring

E-mail do contato.

Example: "johndoe@email.com"
monesConversationSlugstring

Identificador da conversa onde o contato será criado ou atualizado.

Example: "00000a000a0000bb0cc0d0000000000"
atributeValueIdsArray of integers(int64)

Lista de IDs dos valores de atributos personalizados atribuídos ao contato.

  • Deve conter obrigatoriamente o valor do atributo configurado como chave (key) no workspace.
  • Pode conter valores adicionais.
Example: [1,2,3]
contactItemActivationobject(ContactItemActivationRequest)

Atributo utilizado para ativar o contato ao iniciar a conversa com o BOT.

curl -i -X POST \
  https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/key \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "firstname": "string",
    "lastname": "string",
    "ddi": 0,
    "phone": 0,
    "email": "string",
    "monesConversationSlug": "string",
    "atributeValueIds": [
      0
    ],
    "contactItemActivation": {
      "attributeId": 0
    }
  }'

Responses

Contato criado/atualizado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
firstnamestring
Example: "John"
lastnamestring
Example: "Doe"
ddiinteger(int32)
Example: 55
phoneinteger(int64)
Example: 5511912345678
emailstring
Example: "johndoe@email.com"
cbrEditorsArray of strings or null or null
Example: ["valor 1","valor 2"]
notestring or null
Example: "Este contato possui notas"
slugstring
Example: "00000a000a0000bb0cc0d0000000000"
contactItemGroupValueArray of objects(ContactItemGroupValueResponse)
confirmOptinResponseArray of objects(ConfirmOptinResponse)
Response
application/json
{
  "data": {
    "contactItem": { … }
  }
}

Buscar todos os atributos de contato

Request

Permite buscar a lista de todas as informações personalizadas dos seus contatos para o workspace autenticado.

Security
x-api-key
curl -i -X GET \
  https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Atributos encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
namestring
Example: "Setor"
Response
application/json
{
  "data": {
    "contactGroups": [ … ]
  }
}

Criar um novo atributo de contato

Request

Cria uma nova categoria de informações para seus contatos. Exemplo: você pode criar um campo chamado 'Setor' para armazenar o setor do cliente.

Security
x-api-key
Bodyapplication/jsonrequired

Dados do atributo de contato a ser criado

namestring

Nome do atributo.

Example: "Setor"
workspaceobject(ContactGroupWorkspaceRequest)

Payload do workspace onde será registrado o atributo.

curl -i -X POST \
  https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "workspace": {
      "id": 0
    }
  }'

Responses

Atributo criado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
namestring
Example: "Setor"
Response
application/json
{
  "data": {
    "id": 0,
    "createdAt": "2000-01-01T00:00:00.000Z",
    "name": "string",
    "workspace": { … },
    "contactGroupValues": null
  }
}

Cadastrar um novo valor em um atributo

Request

Adiciona um novo valor dentro de uma categoria. Exemplo: dentro do atributo 'Departamento', cadastrar o valor 'Vendas'.

Security
x-api-key
Bodyapplication/jsonrequired

Dados do valor a ser criado

contactGroupobject(ContactGroupBasicRequest)

Payload do atributo de contato que o valor será associado.

descriptionstring

Descrição do valor.

Example: "Departamento responsável pelas operações de vendas da empresa."
groupValuestring

Valor do atributo.

Example: "Vendas"
curl -i -X POST \
  https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group/value \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "contactGroup": {
      "id": 0
    },
    "description": "string",
    "groupValue": "string"
  }'

Responses

Valor criado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
groupValuestring
Example: "Marketing"
descriptionstring
Example: "Setor responsável por estratégias de promoção, comunicação e posicionamento no mercado."
contactGroupobject(ContactGroupResponse)
Response
application/json
{
  "data": {
    "contactGroupValue": { … }
  }
}

Buscar um contatos paginados por filtro

Request

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'.

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

Identificador do workspace

contactIdinteger(int64)required

Identificador da lista de contatos

lengthinteger(int32)[ 10 .. 100 ]required

Quantidade de contatos por página, mínimo 10 e máximo 100

currentPageinteger(int32)required

Página atual

Query
contactItemFilterobject(ContactItemFilter)required

Filtro de busca:

  • name (string): Nome do contato.
  • phone (string): Telefone do contato (formato: DDI+DDD+Número, somente números).
  • email (string): Email do contato.
  • contactGroupId (integer): Identificador do atributo.
  • contactGroupValue (string): Valor do atributo.
  • order (integer): Critério de ordenação dos resultados: • 0 = ordenar por nome e sobrenome • 1 = ordenar apenas por sobrenome

Você pode filtrar por qualquer combinação desses campos. Por exemplo, para buscar apenas por nome, informe apenas o parâmetro 'name' e omita os demais.

Caso não deseje aplicar filtros, envie o objeto vazio: {}

contactItemFilter.​namestring

Nome do contato.

Example: "John Doe"
contactItemFilter.​phonestring

DDI do contato.

Example: "55"
contactItemFilter.​emailstring

Email do contato.

Example: "johndoe@email.com"
contactItemFilter.​contactGroupIdinteger(int64)

Identificador do atributo de contato.

Example: 1
contactItemFilter.​contactGroupValuestring

Valor do atributo de contato.

Example: "Vendas"
contactItemFilter.​orderinteger(int32)

Ordenação para busca.

Example: 1
curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/{workspaceId}/{contactId}/{length}/{currentPage}?name=John+Doe&phone=55&email=johndoe%40email.com&contactGroupId=1&contactGroupValue=Vendas&order=1' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Contatos encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
firstnamestring
Example: "John"
lastnamestring
Example: "Doe"
ddiinteger(int32)
Example: 55
phoneinteger(int64)
Example: 5511912345678
emailstring
Example: "johndoe@email.com"
cbrEditorsArray of strings or null or null
Example: ["valor 1","valor 2"]
notestring or null
Example: "Este contato possui notas"
slugstring
Example: "00000a000a0000bb0cc0d0000000000"
contactItemGroupValueArray of objects(ContactItemGroupValueResponse)
confirmOptinResponseArray of objects(ConfirmOptinResponse)
Response
application/json
{
  "data": {
    "contactItems": { … }
  }
}

Buscar valores e atributos de um contato pelo ID

Request

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).

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

Identificador do contato

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/group/value/{contactItemId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Valores e atributos encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
contactGroupValueobject(ContactGroupValueResponse)
contactItemobject(ContactItemResponse)
contactGroupobject(ContactGroupResponse)
Response
application/json
{
  "data": {
    "contactItemGroupValues": [ … ]
  }
}

Buscar valores e atributos de um contato pelo slug

Request

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).

Security
x-api-key
Path
contactItemSlugstringrequired

Identificador do contato

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/group/value/slug/{contactItemSlug}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Valores e atributos encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
contactGroupValueobject(ContactGroupValueResponse)
contactItemobject(ContactItemResponse)
contactGroupobject(ContactGroupResponse)
Response
application/json
{
  "data": {
    "contactItemGroupValues": [ … ]
  }
}

Remover registros de bloqueios de um chat

Request

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
Security
x-api-key
Path
conversationSlugstringrequired

Identificador da conversa

chatIdstringrequired

Identificador do chat

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/clean/blocks/{conversationSlug}/{chatId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Bloqueios removidos com sucesso

Bodyapplication/json
Response
application/json
{}

Buscar um atributo de contato pelo nome

Request

Permite buscar informações personalizadas dos seus contatos, como por exemplo 'Nome', 'Idade', 'Cidade'.

Security
x-api-key
Path
contactGroupNamestringrequired

Nome do atributo de contato

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group/{contactGroupName}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Atributo encontrado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
namestring
Example: "Setor"
Response
application/json
{
  "data": {
    "id": 0,
    "createdAt": "2000-01-01T00:00:00.000Z",
    "name": "string",
    "workspace": null,
    "contactGroupValues": null
  }
}

Buscar todos os valores de um atributo pelo ID

Request

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'

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

Identificador do atributo

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group/value/{contactGroupId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Valores encontrados com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
groupValuestring
Example: "Marketing"
descriptionstring
Example: "Setor responsável por estratégias de promoção, comunicação e posicionamento no mercado."
contactGroupobject(ContactGroupResponse)
Response
application/json
{
  "data": {
    "contactGroupValues": { … }
  }
}

Buscar um valor dentro de um atributo

Request

Verifica se um determinado valor está cadastrado dentro de uma categoria. Por exemplo: verificar se o valor 'Marketing' existe dentro da categoria 'Setor'.

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

Identificador do atributo

contactGroupValuestringrequired

Valor do atributo

curl -i -X GET \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/group/value/{contactGroupId}/value/{contactGroupValue}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Valor encontrado com sucesso

Bodyapplication/json
idinteger(int64)
Example: 1
groupValuestring
Example: "Marketing"
descriptionstring
Example: "Setor responsável por estratégias de promoção, comunicação e posicionamento no mercado."
contactGroupobject(ContactGroupResponse)
Response
application/json
{
  "data": {
    "contactGroupValue": { … }
  }
}

Excluir um contato com base em dados informados

Request

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'.

Security
x-api-key
Path
conversationSlugstringrequired

Identificador da conversa

keystringrequired

Valor do atributo-chave

curl -i -X DELETE \
  'https://docs.omotor.com.br/_mock/openapi/v2/integrations/contact/item/{conversationSlug}/key/{key}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Contato excluído com sucesso

Bodyapplication/json
Response
application/json
{}

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