Welcome Bot API documentation - nsftx/incubator-2019-slack-bot-services GitHub Wiki

Welcome-bot API

Message operations:

  1. Creating message (POST):


  • request body:
{  
	"text": "asdasd",  
	"title": "12312312"  
} 

  • response body:
{
    "title": "12312312",
    "text": "asdasd",
    "id": 6,
    "created_at": "2019-07-24T09:59:22.206+0000"
}
  • response header:

  1. Dohvati sve poruke (GET):

{
    "content": [
        {
            "title": "asd",
            "text": "1111",
            "id": 1,
            "created_at": "2019-07-24T06:57:54.000+0000"
        },
        {
            "title": "1231231231",
            "text": "123123",
            "id": 2,
            "created_at": "2019-07-24T06:57:59.000+0000"
        }
    ],
    "pageable": {
        "sort": {
            "unsorted": true,
            "sorted": false,
            "empty": true
        },
        "offset": 0,
        "pageSize": 20,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
    },
    "totalPages": 1,
    "totalElements": 6,
    "last": true,
    "number": 0,
    "sort": {
        "unsorted": true,
        "sorted": false,
        "empty": true
    },
    "size": 20,
    "first": true,
    "numberOfElements": 6,
    "empty": false
}
  1. Dohvati određenu poruku (GET):

{
    "title": "asd",
    "text": "1111",
    "id": 1,
    "created_at": "2019-07-24T06:57:54.000+0000"
}
  1. Apdejtuj određenu poruku (PUT)

{
	"text": "izmjenjen tekst",
	"title": "title poruke"
}
  • response body:
{
    "title": "title poruke",
    "text": "izmjenjen tekst",
    "id": 1,
    "created_at": "2019-07-24T06:57:54.000+0000"
}
  1. Izbrisi odredjenu poruku (DELETE)

Rad sa triggerima:

  1. Kreiraj triger (POST):

{
	"channel": "channel one",
	"triggerType": "on chanel join",
	"active": "true",
	"messageId": "5"
}
  • response body:
{
    "triggerId": 36,
    "channel": "channel one",
    "triggerType": "on chanel join",
    "active": true,
    "message": {
        "title": "12312312",
        "text": "asdasd",
        "id": 5,
        "created_at": "2019-07-24T07:52:12.000+0000"
    }
}
  1. Dohvati sve triggere (GET):

{
    "content": [
        {
            "triggerId": 36,
            "channel": "channel one",
            "triggerType": "on chanel join",
            "active": true,
            "message": {
                "title": "12312312",
                "text": "asdasd",
                "id": 5,
                "created_at": "2019-07-24T07:52:12.000+0000"
            }
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "pageSize": 20,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
    },
    "totalPages": 1,
    "totalElements": 7,
    "last": true,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "size": 20,
    "first": true,
    "numberOfElements": 7,
    "empty": false
}
  1. Dohvati određeni trigger (GET):

{
    "triggerId": 36,
    "channel": "channel one",
    "triggerType": "on chanel join",
    "active": true,
    "message": {
        "title": "12312312",
        "text": "asdasd",
        "id": 5,
        "created_at": "2019-07-24T07:52:12.000+0000"
    }
}
  1. Izmjeni određeni trigger (PUT)

{
	"channel": "izmjenjen channel",
	"triggerType": "on chanel join",
	"active": "true",
	"messageId": "1"
}
  • response body:
{
    "triggerId": 1,
    "channel": "izmjenjen channel",
    "triggerType": "on chanel join",
    "active": true,
    "message": {
        "title": "12312312",
        "text": "asdasd",
        "id": 1,
        "created_at": "2019-07-24T11:22:27.000+0000"
    }
}
  1. Izbrisi odredjeni trigger (DELETE)

Rad sa schedualima:

  1. Kreiraj schedules (POST):

{
	"active": true,
	"repeat": true,
	"messageId": "1",
	"runAt": "2019-07-25T11:03:40.356Z"
}
  • response body:
{
    "id": 1,
    "active": true,
    "repeat": true,
    "runAt": "2019-07-25T11:03:40.356+0000",
    "message": {
        "id": 1,
        "title": "123123123",
        "text": "123123123123123",
        "created_at": "2019-07-25T13:22:40.000+0000"
    }
}
  1. Dohvati sve schedules (GET):

{
    "content": [
        {
            "id": 1,
            "active": true,
            "repeat": true,
            "runAt": "2019-07-25T11:03:40.000+0000",
            "message": {
                "id": 1,
                "title": "123123123",
                "text": "123123123123123",
                "created_at": "2019-07-25T13:22:40.000+0000"
            }
        }
    ],
    "pageable": {
        "sort": {
            "unsorted": true,
            "sorted": false,
            "empty": true
        },
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 20,
        "paged": true,
        "unpaged": false
    },
    "totalPages": 1,
    "totalElements": 1,
    "last": true,
    "number": 0,
    "sort": {
        "unsorted": true,
        "sorted": false,
        "empty": true
    },
    "size": 20,
    "first": true,
    "numberOfElements": 1,
    "empty": false
}
  1. Dohvati određeni schedules (GET):

{
    "id": 1,
    "active": true,
    "repeat": true,
    "runAt": "2019-07-25T11:03:40.000+0000",
    "message": {
        "id": 1,
        "title": "123123123",
        "text": "123123123123123",
        "created_at": "2019-07-25T13:22:40.000+0000"
    }
}
  1. Izmjeni određeni trigger (PUT)

{
	"active": true,
	"repeat": false,
	"messageId": "1",
	"runAt": "2020-07-25T11:03:40.356Z"
}
  • response body:
{
    "id": 1,
    "active": true,
    "repeat": false,
    "runAt": "2020-07-25T11:03:40.356+0000",
    "message": {
        "id": 1,
        "title": "123123123",
        "text": "123123123123123",
        "created_at": "2019-07-25T13:22:40.000+0000"
    }
}
  1. Izbrisi odredjeni schedules (DELETE)