Neppo Chat API — Bot – Sankhya Gestão de Negócios

📘 Documentação Neppo Chat API | 🏠 Visão Geral (índice) · 🔎 Guia de Busca · 📦 Modelos de Dados

O que você pode fazer com este módulo
Exemplo de chamada
Referência técnica completa
V1 — bot-controller (10 endpoints)
V2 — bot-controller-v-2 (5 endpoints)

O que é este módulo?

Gerencia os chatbots automáticos que respondem clientes sem intervenção humana.

Quem usa	Times de produto, operações, analistas de automação.
Problema que resolve	Sem bots, toda interação exige um atendente humano, aumentando custos operacionais e o tempo de resposta fora do horário comercial.
Impacto na experiência do cliente	Clientes recebem respostas imediatas 24/7 para perguntas frequentes, sem esperar na fila por um atendente.

O que você pode fazer com este módulo

Operação	O que faz (em linguagem simples)
Listar bots	Retorna todos os chatbots configurados na plataforma.
Criar/atualizar bot	Configura um novo bot ou ajusta um existente.
Acionar bot via hook	Dispara manualmente o fluxo de diálogo de um bot para um contato específico.
Remover bot	Desativa e exclui um chatbot da plataforma.

Exemplo de chamada

Substitua SEU_TOKEN_AQUI pelo Bearer token obtido via OAuth2.

curl -X POST "https://hml-chat-api.neppo.com.br/api/v1/bot/save" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}'

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

Valores ilustrativos (esqueleto do schema). Os campos retornados seguem o modelo de dados do recurso.

Endpoints de listagem (findAll) e busca (findOne) deste módulo recebem um corpo com filtros (conditions) e paginação. Veja como montar o corpo de busca no guia: .

Referência técnica completa

V1 — `bot-controller` (10 endpoints)

`/api/bot`

findAll · operationId: findAllUsingPOST_15

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomPageRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "status",
      "value": "OFFLINE",
      "operator": "EQ",
      "logic": "AND"
    }
  ],
  "page": 0,
  "size": 10
}

Respostas

Código	Descrição	Schema
200	OK	PageResponse«Bot»
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "page": 0,
  "size": 10,
  "results": [
    {
      "active": true,
      "agent": {
        "accessKey": "string",
        "active": true,
        "agent": {},
        "birthDate": "2024-01-01T00:00:00Z",
        "company": {},
        "country": "string",
        "cpf": "string",
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "createdFromSurvey": true,
        "defaultLocale": "string",
        "displayName": "string",
        "email": "string",
        "externalCode": "string",
        "firstAccess": true,
        "firstLogin": "2024-01-01T00:00:00Z",
        "formal": true,
        "id": 0,
        "lastLogin": "2024-01-01T00:00:00Z",
        "name": "string",
        "operation": "string",
        "originUser": "string",
        "phone": "string",
        "priority": 0,
        "profile": {},
        "ticketUserId": 0,
        "tm2": true,
        "typeUser": "string",
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "userName": "string",
        "usingMFA": true,
        "visible": true,
        "password": "string"
      },
      "botTree": {
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "id": 0,
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "name": "string",
        "description": "string",
        "active": true,
        "version": 0
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "createdBy": "string",
      "external": true,
      "id": 0,
      "survey": true,
      "updatedAt": "2024-01-01T00:00:00Z",
      "updatedBy": "string"
    }
  ]
}

`/api/bot/delete`

delete · operationId: deleteUsingDELETE_12

Auth: Application & Application User | Escopos: delete

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): integer (int64)

Exemplo de corpo:

Respostas

Código	Descrição	Schema
200	OK	boolean
204	No Content	—
401	Unauthorized	—
403	Forbidden	—

Exemplo de resposta (200 OK):

true

`/api/bot/dialog/hook/{botName}`

dialogHook · operationId: dialogHookUsingPOST

Auth: Application & Application User

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token
botName	path	string	Sim	botName

Request body (obrigatório): BotDialogHookDto

Exemplo de corpo:

{
  "args": {}
}

Respostas

Código	Descrição	Schema
200	OK	object
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{}

`/api/bot/save`

insert · operationId: insertUsingPOST_12

Auth: Application & Application User | Escopos: write

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): Bot

Exemplo de corpo:

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

`/api/bot/unique`

findOne · operationId: findOneUsingPOST_15

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "id",
      "value": "42",
      "operator": "EQNUM"
    }
  ]
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

`/api/v1/bot`

findAll · operationId: findAllUsingPOST_16

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomPageRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "status",
      "value": "OFFLINE",
      "operator": "EQ",
      "logic": "AND"
    }
  ],
  "page": 0,
  "size": 10
}

Respostas

Código	Descrição	Schema
200	OK	PageResponse«Bot»
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "page": 0,
  "size": 10,
  "results": [
    {
      "active": true,
      "agent": {
        "accessKey": "string",
        "active": true,
        "agent": {},
        "birthDate": "2024-01-01T00:00:00Z",
        "company": {},
        "country": "string",
        "cpf": "string",
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "createdFromSurvey": true,
        "defaultLocale": "string",
        "displayName": "string",
        "email": "string",
        "externalCode": "string",
        "firstAccess": true,
        "firstLogin": "2024-01-01T00:00:00Z",
        "formal": true,
        "id": 0,
        "lastLogin": "2024-01-01T00:00:00Z",
        "name": "string",
        "operation": "string",
        "originUser": "string",
        "phone": "string",
        "priority": 0,
        "profile": {},
        "ticketUserId": 0,
        "tm2": true,
        "typeUser": "string",
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "userName": "string",
        "usingMFA": true,
        "visible": true,
        "password": "string"
      },
      "botTree": {
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "id": 0,
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "name": "string",
        "description": "string",
        "active": true,
        "version": 0
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "createdBy": "string",
      "external": true,
      "id": 0,
      "survey": true,
      "updatedAt": "2024-01-01T00:00:00Z",
      "updatedBy": "string"
    }
  ]
}

`/api/v1/bot/delete`

delete · operationId: deleteUsingDELETE_13

Auth: Application & Application User | Escopos: delete

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): integer (int64)

Exemplo de corpo:

Respostas

Código	Descrição	Schema
200	OK	boolean
204	No Content	—
401	Unauthorized	—
403	Forbidden	—

Exemplo de resposta (200 OK):

true

`/api/v1/bot/dialog/hook/{botName}`

dialogHook · operationId: dialogHookUsingPOST_1

Auth: Application & Application User

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token
botName	path	string	Sim	botName

Request body (obrigatório): BotDialogHookDto

Exemplo de corpo:

{
  "args": {}
}

Respostas

Código	Descrição	Schema
200	OK	object
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{}

`/api/v1/bot/save`

insert · operationId: insertUsingPOST_13

Auth: Application & Application User | Escopos: write

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): Bot

Exemplo de corpo:

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

`/api/v1/bot/unique`

findOne · operationId: findOneUsingPOST_16

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "id",
      "value": "42",
      "operator": "EQNUM"
    }
  ]
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

V2 — `bot-controller-v-2` (5 endpoints)

`/api/v2/bot`

findAll · operationId: findAllUsingPOST_17

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomPageRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "status",
      "value": "OFFLINE",
      "operator": "EQ",
      "logic": "AND"
    }
  ],
  "page": 0,
  "size": 10
}

Respostas

Código	Descrição	Schema
200	OK	PageResponse«Bot»
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "page": 0,
  "size": 10,
  "results": [
    {
      "active": true,
      "agent": {
        "accessKey": "string",
        "active": true,
        "agent": {},
        "birthDate": "2024-01-01T00:00:00Z",
        "company": {},
        "country": "string",
        "cpf": "string",
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "createdFromSurvey": true,
        "defaultLocale": "string",
        "displayName": "string",
        "email": "string",
        "externalCode": "string",
        "firstAccess": true,
        "firstLogin": "2024-01-01T00:00:00Z",
        "formal": true,
        "id": 0,
        "lastLogin": "2024-01-01T00:00:00Z",
        "name": "string",
        "operation": "string",
        "originUser": "string",
        "phone": "string",
        "priority": 0,
        "profile": {},
        "ticketUserId": 0,
        "tm2": true,
        "typeUser": "string",
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "userName": "string",
        "usingMFA": true,
        "visible": true,
        "password": "string"
      },
      "botTree": {
        "createdAt": "2024-01-01T00:00:00Z",
        "createdBy": "string",
        "id": 0,
        "updatedAt": "2024-01-01T00:00:00Z",
        "updatedBy": "string",
        "name": "string",
        "description": "string",
        "active": true,
        "version": 0
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "createdBy": "string",
      "external": true,
      "id": 0,
      "survey": true,
      "updatedAt": "2024-01-01T00:00:00Z",
      "updatedBy": "string"
    }
  ]
}

`/api/v2/bot/delete`

delete · operationId: deleteUsingDELETE_14

Auth: Application & Application User | Escopos: delete

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): integer (int64)

Exemplo de corpo:

Respostas

Código	Descrição	Schema
200	OK	boolean
204	No Content	—
401	Unauthorized	—
403	Forbidden	—

Exemplo de resposta (200 OK):

true

`/api/v2/bot/dialog/hook/{botName}`

dialogHook · operationId: dialogHookUsingPOST_2

Auth: Application & Application User

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token
botName	path	string	Sim	botName

Request body (obrigatório): BotDialogHookDto

Exemplo de corpo:

{
  "args": {}
}

Respostas

Código	Descrição	Schema
200	OK	object
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{}

`/api/v2/bot/save`

insert · operationId: insertUsingPOST_14

Auth: Application & Application User | Escopos: write

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): Bot

Exemplo de corpo:

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

`/api/v2/bot/unique`

findOne · operationId: findOneUsingPOST_17

Auth: Application & Application User | Escopos: read

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
Authorization	header	string	Não	Bearer token

Request body (obrigatório): CustomRequest

Exemplo de corpo:

{
  "conditions": [
    {
      "key": "id",
      "value": "42",
      "operator": "EQNUM"
    }
  ]
}

Respostas

Código	Descrição	Schema
200	OK	Bot
201	Created	—
401	Unauthorized	—
403	Forbidden	—
404	Not Found	—

Exemplo de resposta (200 OK):

{
  "active": true,
  "agent": {
    "accessKey": "string",
    "active": true,
    "agent": {},
    "birthDate": "2024-01-01T00:00:00Z",
    "company": {},
    "country": "string",
    "cpf": "string",
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "createdFromSurvey": true,
    "defaultLocale": "string",
    "displayName": "string",
    "email": "string",
    "externalCode": "string",
    "firstAccess": true,
    "firstLogin": "2024-01-01T00:00:00Z",
    "formal": true,
    "id": 0,
    "lastLogin": "2024-01-01T00:00:00Z",
    "name": "string",
    "operation": "string",
    "originUser": "string",
    "phone": "string",
    "priority": 0,
    "profile": {},
    "ticketUserId": 0,
    "tm2": true,
    "typeUser": "string",
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "userName": "string",
    "usingMFA": true,
    "visible": true,
    "password": "string"
  },
  "botTree": {
    "createdAt": "2024-01-01T00:00:00Z",
    "createdBy": "string",
    "id": 0,
    "updatedAt": "2024-01-01T00:00:00Z",
    "updatedBy": "string",
    "name": "string",
    "description": "string",
    "active": true,
    "version": 0
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "createdBy": "string",
  "external": true,
  "id": 0,
  "survey": true,
  "updatedAt": "2024-01-01T00:00:00Z",
  "updatedBy": "string"
}

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 0

Pesquisa

Neppo Chat API — Bot

O que você pode fazer com este módulo

Exemplo de chamada

Referência técnica completa

V1 — `bot-controller` (10 endpoints)

`/api/bot`

`/api/bot/delete`

`/api/bot/dialog/hook/{botName}`

`/api/bot/save`

`/api/bot/unique`

`/api/v1/bot`

`/api/v1/bot/delete`

`/api/v1/bot/dialog/hook/{botName}`

`/api/v1/bot/save`

`/api/v1/bot/unique`

V2 — `bot-controller-v-2` (5 endpoints)

`/api/v2/bot`

`/api/v2/bot/delete`

`/api/v2/bot/dialog/hook/{botName}`

`/api/v2/bot/save`

`/api/v2/bot/unique`

Comentários

Pesquisa

O que você pode fazer com este módulo

Exemplo de chamada

Referência técnica completa

V1 — bot-controller (10 endpoints)

/api/bot

/api/bot/delete

/api/bot/dialog/hook/{botName}

/api/bot/save

/api/bot/unique

/api/v1/bot

/api/v1/bot/delete

/api/v1/bot/dialog/hook/{botName}

/api/v1/bot/save

/api/v1/bot/unique

V2 — bot-controller-v-2 (5 endpoints)

/api/v2/bot

/api/v2/bot/delete

/api/v2/bot/dialog/hook/{botName}

/api/v2/bot/save

/api/v2/bot/unique

V1 — `bot-controller` (10 endpoints)

`/api/bot`

`/api/bot/delete`

`/api/bot/dialog/hook/{botName}`

`/api/bot/save`

`/api/bot/unique`

`/api/v1/bot`

`/api/v1/bot/delete`

`/api/v1/bot/dialog/hook/{botName}`

`/api/v1/bot/save`

`/api/v1/bot/unique`

V2 — `bot-controller-v-2` (5 endpoints)

`/api/v2/bot`

`/api/v2/bot/delete`

`/api/v2/bot/dialog/hook/{botName}`

`/api/v2/bot/save`

`/api/v2/bot/unique`