消息配置列表查询

请求参数

Query 参数

asc

string

升序排序

可选

code

string

配置编号

可选

示例值:

全局唯一，前端填入，固定8个字符，只支持大写字母、_、-、阿拉伯数字

desc

string

降序排序

可选

enable

string

是否启用

可选

level

integer

消息等级

可选

示例值:

0：普通（默认）；1：严重告警；2：紧急告警

msgTemplate

string

内容模板

可选

msgTemplateTitle

string

摘要模板

可选

msgType

integer

消息分类

可选

示例值:

0：普通消息，1：告警消息

name

string

配置名称

可选

page

integer

第几页，从1开始

必需

pageParam

string

分页参数

必需

preset

string

可选

是否为系统默认消息配置

示例值:

true是，false不是

push2All

string

是否推送所有人

可选

push2ExternalUserIds

array[string]

可选

消息推送至指定的外部联系人的ID

push2InnerUsers[0].customerId

string

可选

push2InnerUsers[0].departmentId

string

可选

push2InnerUsers[0].userId

string

可选

pushTimeSetting

string

推送时间设置

可选

示例值:

包括：立刻（immediately）、时间范围（开始时间~截止时间）

pushType

array[string]

推送方式

可选

size

integer

分页大小

必需

tenant

string

租户

可选

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200OK

application/json

Body

_embedded

object (IPage«MessageConfigVo»)

可选

current

integer <int64>

可选

pages

integer <int64>

可选

records

array[object (MessageConfigVo) {17}]

可选

size

integer <int64>

可选

total

integer <int64>

可选

code

integer <int32>

可选

message

string

可选

timestamp

string

可选

示例

{
    "_embedded": {
        "current": 0,
        "pages": 0,
        "records": [
            {
                "code": "string",
                "createTime": "string",
                "isEnable": true,
                "isPreset": false,
                "level": "0：普通（默认）；1：严重告警；2：紧急告警",
                "msgTemplate": "string",
                "msgTemplateTitle": "string",
                "msgType": "0：普通消息，1：告警消息",
                "name": "string",
                "push2All": true,
                "push2ExternalUserIds": [
                    "string"
                ],
                "push2InnerUsers": [
                    {
                        "customerId": "string",
                        "departmentId": "string",
                        "userId": "string",
                        "username": "string"
                    }
                ],
                "pushAdditional": {},
                "pushTimeSetting": "string",
                "pushType": "可选值: 站内信(info)、移动端app(mobile)、短消息(sms)、微信(wx)、邮件(email)",
                "tenant": "string",
                "updateTime": "string"
            }
        ],
        "size": 0,
        "total": 0
    },
    "code": 0,
    "message": "string",
    "timestamp": "string"
}

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found