https://github.com/thiagojacinto/atende-ai-bot-service

Bot application that performs scheduling activities with some of Twilio's APIs
https://github.com/thiagojacinto/atende-ai-bot-service

bot javascript nodejs twilio twilio-api

Last synced: 8 days ago
JSON representation

Bot application that performs scheduling activities with some of Twilio's APIs

• Host: GitHub
• URL: https://github.com/thiagojacinto/atende-ai-bot-service
• Owner: thiagojacinto
• License: mit
• Created: 2020-05-02T17:20:44.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T21:22:58.000Z (almost 4 years ago)
• Last Synced: 2023-03-10T05:46:51.117Z (almost 2 years ago)
• Topics: bot, javascript, nodejs, twilio, twilio-api
• Language: JavaScript
• Size: 110 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AtendeAI

> A simple Bot Service: _**Scheduling done autonomously**_.

Bot application that performs scheduling activities with some of Twilio's APIs

## A que se propõe:

Desenvolvido em resposta ao Desafio MEGAHACK proposto pela Shawee e Sebrae, esta aplicação tem por objetivos:

- [ ] Integrar-se com a plataforma popular de mensagem _WhatsApp_;

- [ ] Utilizar essa integração para responder a pedidos de agendamento;

## Status do MVP

O projeto se baseia em APIs da ***Twilio*** que facilitam duas integrações:

- Uso de mensageria atravéis do WhatsApp ([ref](https://www.twilio.com/whatsapp));

- Plataforma **Autopilot**, que usa inteligência artificial para construir e treinar os Bots ([ref](https://www.twilio.com/autopilot)).

É possível integrar o Autopilot com chamadas a uma API externa, que então interage com banco de dados. Assim, neste repositório ficará a API REST desenvolvida em Node e aliada a um banco de dados MongoDB, cujas funções são:

- [x] [Cadastro de um agendamento](https://github.com/thiagojacinto/atende-ai-bot-service/blob/10f0cc62beba0f17fabe8be378cf2921e4318ff8/src/Controllers/AgendaController.js#L10) a partir de um número de telefone;

- [x] Exibir informações sobre um agendamento [[1]](https://github.com/thiagojacinto/atende-ai-bot-service/blob/10f0cc62beba0f17fabe8be378cf2921e4318ff8/src/Controllers/AgendaController.js#L5), [[2]](https://github.com/thiagojacinto/atende-ai-bot-service/blob/10f0cc62beba0f17fabe8be378cf2921e4318ff8/src/Controllers/AgendaController.js#L38) previamente cadastrado.

- [x] Realizar a [confirmação ou desmarcação](https://github.com/thiagojacinto/atende-ai-bot-service/blob/10f0cc62beba0f17fabe8be378cf2921e4318ff8/src/Controllers/AgendaController.js#L59) do agendamento.

## Como usar

A partir de configuração - do banco de dados MongoDB e da porta selecionada - realizada em um arquivo separado [`config.js`](https://github.com/thiagojacinto/atende-ai-bot-service/blob/master/src/config.js), é somente necessário usar o comando:

```javascript

npm start

```

e então a API estará rodando localmente, cujo teste simples pode ser realizado digitando e esperando um status `200`:

```curl

curl http://localhost:3000/v1/agendamentos

```