7.Управление сообщениями

GET Просмотр всех сообщений пользователя#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/message?page=1&perPage=2&user=ivanov.i&msgType=0

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "total": 1,
        "page": "1",
        "items": [
            {
                "id": "aa168a37-5fc4-4379-88bd-16c3509b084b",
                "userId": "2adba836-4984-458d-9827-3706067e767a",
                "username": "ivanov.i",
                "datetime": "2025-02-26 13:14:30",
                "createTime": "2025-02-26 13:14:30",
                "message": "message content test",
                "url": "https://www.test.com/",
                "toasted": false,
                "readed": false,
                "type": 0,
                "urlType": 2,
                "title": null,
                "terminal": 1
            }
        ]
    }
}

Failed (404)#

GET Просмотр непрочитанных сообщений пользователя#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: GET {{API_PATH_V3}}/message/unread?page=1&perPage=2&user=ivanov.i&msgType=0

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": {
        "total": 629,
        "page": "1",
        "items": [
            {
                "id": "3715f477-93b0-489b-bd2d-57af8501aaf0",
                "userId": "c3e118ac-678c-4e4c-8899-bc4d2d917bfb",
                "username": "admin4",
                "datetime": "2025-02-26 13:02:32",
                "createTime": "2025-02-26 13:02:32",
                "message": "message content test",
                "url": "https://www.test.com/",
                "toasted": false,
                "readed": false,
                "type": 0,
                "urlType": 2,
                "title": null,
                "terminal": 1
            }
        ]
    }
}

Failed (404)#

POST Отправка системного сообщения пользователю#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/message/user/push

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "user" : "ivanov.i" ,
        "content" : "message content test" ,
        "url" : "https://www.test.com/"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Failed (404)#

POST Отправка системного сообщения роли#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/message/role/push

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "role" : "Test Role A",
        "content" : "message content test" ,
        "url" : "https://www.test.com/"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "data": [
        {
            "status" : true //status
        }
    ]
}

Failed (201)#

POST Отправка системного сообщения департаменту#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: POST {{API_PATH_V3}}/message/depost/push

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "department" : "[\"Finance Department\", \"Second Finance Department\"]",
        "position" : "Test Post 1",
        "content" : "message content test 1" ,
        "url" : "https://www.test.com/"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Failed (201)#

PUT Отметка сообщения как прочитанного#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: PUT {{API_PATH_V3}}/message/read

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры body запроса.

[
    {
        "user" : "ivanov.i" ,
        "msgId" : "6407ac3b-84e3-459c-83d7-5d1a1cb602fe"
    }
]

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": [
        {
            "status": true
        }
    ]
}

Failed (404)#

DEL Удаление отдельного сообщения#

Основная информация#

Статус интерфейса: Опубликован

URL интерфейса: DEL {{API_PATH_V3}}/message?user=ivanov.i&msgId=6407ac3b-84e3-459c-83d7-5d1a1cb602fe&msgType=0

Content-Type: application/json

Способ аутентификации: Аутентификация не требуется

Передаваемые параметры#

Параметры запроса.

Возвращаемые параметры (json + таблица)#

Success (200)#

{
    "status": 200,
    "data": "success"
}

Failed (404)#