Download OpenAPI specification:Download
Com o API-Services, podemos fazer a manipulação do banco de dados, criando, retornando e até atualizando documentos dentro do MongoDB. Também podemos criar usuários para realizar essas tarefas e enviar mensagens de texto.
Para começar a manipular o Banco de dados, basta criar um novo usuário na guia Usuários. Esse endpoint retornará um Apikey de usuário, que deve ser inserido no Header da sua requisição.
Cria um documento dentro de uma collection.
| owner | string Proprietário da collection |
| collection | string Nome da collection que deseja enviar o documento |
object Dados/Documentos a serem guardados nessa collection |
{- "owner": "Exemplo",
- "collection": "string",
- "data": {
- "documento": "teste"
}
}{- "owner": "Exemplo",
- "body": {
- "documento": "teste"
}, - "_id": "string",
- "createdAt": "string",
- "udpateAt": "string",
- "__v": 0
}Retorna o documento com o id passado nos parâmetros.
| database required | any Nome da collection |
| key required | any ID do documento que deseja ver |
{- "id": "string",
- "owner": "string",
- "body": {
- "documento": "teste"
}, - "createdAt": "string",
- "udpateAt": "string",
- "__v": 0
}Retorna todos os documentos dentro da collection.
| database required | any Nome da collection |
{- "id": "string",
- "owner": "string",
- "body": {
- "documento": "teste"
}, - "createdAt": "string",
- "udpateAt": "string",
- "__v": 0
}Atualiza os dados de um documento dentro de determinada collection.
| database required | any Nome da collection |
| key required | any ID do documento que deseja atualizar |
object | |||||
| |||||
{- "data": {
- "documento": 0,
- "nome": "example"
}
}{- "id": "string",
- "owner": "string",
- "body": {
- "documento": 0,
- "nome": "example"
}, - "createdAt": "string",
- "udpateAt": "string",
- "__v": 0
}Deleta um documento da collection selecionada.
| database required | any Nome da collection |
| key required | any ID do documento que deseja deletar |
{- "message": "Collection permission denied"
}Envia um SMS ao número informado.
| to | string Número de telefone a ser enviada a mensagem |
| message | string Mensagem a ser enviada |
{- "to": "string",
- "message": "string"
}{- "to": "string",
- "message": "string"
}Adiciona um novo usuário para manipular o Banco de Dados.
| name | string Nome do usuário |
| amount | number Quantidade de requisições que o usuário pode fazer |
{- "name": "Carlos",
- "amount": 200
}{- "Name": "Carlos",
- "Amount": 200,
- "ApiKey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3",
- "Type": "User"
}Atualiza os dados de um usuário já existente.
| apikey | string APIKey gerada no endpoint -> Adicionar novo usuário |
| name | string Novo nome do usuário |
| amount | number Nova quantidade de requisições do usuário |
{- "apikey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3",
- "name": "Carlos",
- "amount": 300
}{- "Id": 12,
- "Name": "Carlos",
- "Amount": 300,
- "ApiKey": "315ad483-d449-4ec7-bd99-2dfc4fa480c3"
}| organization | string |
| bot | string |
| stage | string |
| bucket | string |
| path | string |
| fields | Array of arrays |
object |
{- "organization": "string",
- "bot": "string",
- "stage": "string",
- "bucket": "string",
- "path": "string",
- "fields": [ ],
- "sender": {
- "type": "string",
- "field": 0,
- "template": "string",
- "text": "string",
- "event": "string"
}
}Mostra as conversas no orquestrador do bot e userId de uma data inicial específica.
| bot required | any Nome do bot/agente |
| costumer_id required | any UserID que deseja ver a conversa |
| initialDate | string |
{- "initialDate": "2022-11-07T18:00:23.962Z"
}{- "messages": [ ]
}