2017-03-08 22:16:37 +01:00
|
|
|
# gempbotgo [![Build Status](https://travis-ci.org/gempir/gempbotgo.svg?branch=master)](https://travis-ci.org/gempir/gempbotgo)
|
|
|
|
|
|
|
|
#### What is this?
|
2017-03-08 22:18:55 +01:00
|
|
|
gempbot is a bot I maintain for a couple of channels. It's features differ from other bots in that it doesn't support
|
|
|
|
commands etc. yet, it focuses on logging and providing an api for the logs.
|
|
|
|
|
2017-04-26 19:46:50 +02:00
|
|
|
## API
|
|
|
|
|
2017-04-26 19:45:59 +02:00
|
|
|
**Root Domain** `https://api.gempir.com`
|
|
|
|
|
|
|
|
##### All Requests only with HTTPS!
|
|
|
|
|
|
|
|
|
|
|
|
#### RandomQuote
|
|
|
|
|
|
|
|
Responds with a random message from the give user in that channel.
|
|
|
|
|
|
|
|
|
|
|
|
* **URL** `/channel/%channel%/user/%username%/random`
|
|
|
|
|
|
|
|
* **Methods** `GET`
|
|
|
|
|
|
|
|
* **Parameter**
|
|
|
|
- `%channel%` Channel from which you want the quote
|
|
|
|
- `%username%` Username from whom you want the quote
|
|
|
|
|
|
|
|
* **Success Response**
|
|
|
|
|
|
|
|
* **Code:** 200
|
|
|
|
**Content:** `gempir: My Random Message`
|
|
|
|
|
|
|
|
* **Error Response:** `{"Error":"error finding logs"}`
|
|
|
|
|
|
|
|
- **Notice**
|
|
|
|
|
|
|
|
With the Header Content-Type: "application/json" the response will be in json format. Example:
|
|
|
|
`{
|
|
|
|
"channel": "gempbot",
|
|
|
|
"username": "gempir",
|
|
|
|
"message": "MingLee",
|
|
|
|
"timestamp": "2017-03-12 09:43:22"
|
|
|
|
}`
|
|
|
|
|
|
|
|
#### Userlog
|
|
|
|
|
|
|
|
Responds with the timestamped log of a user in the current month for the given channel.
|
|
|
|
|
|
|
|
|
|
|
|
* **URL** `/channel/%channel%/user/%username%`
|
|
|
|
|
|
|
|
* **Methods** `GET`
|
|
|
|
|
|
|
|
* **Parameter**
|
|
|
|
- `%channel%` Channel that the user wrote in
|
|
|
|
- `%username%` Username that typed in the chat
|
|
|
|
|
|
|
|
* **Success Response**
|
|
|
|
|
|
|
|
* **Code:** 200
|
|
|
|
**Content:**
|
|
|
|
|
|
|
|
[2017-04-1 06:40:24] gempir: HaHaa
|
|
|
|
|
|
|
|
[2017-04-1 06:40:36] gempir: KKona
|
|
|
|
|
|
|
|
[2017-04-1 06:40:43] gempir: NaM
|
|
|
|
|
|
|
|
|
|
|
|
* **Error Response:** `{"message":"Not Found"}`
|
|
|
|
* **Notice**
|
|
|
|
|
2018-04-08 09:27:43 +02:00
|
|
|
* This endpoint will redirect to the current Month and Year so the url will say `/channel/%channel%/user/%username%/2017/April`
|
|
|
|
* With the Header Content-Type: "application/json" the response will be in json format.
|