• 文档
• 应用
• Search Message Rules

Search Message Rules

查询消息规则。

请求格式

POST https://{apigw-address}/app-portal-service/v2.2/message-service/rule/search

请求参数（Header）

名称	必需/可选	数据类型	描述
Authorization	可选	String	身份识别。

请求参数（URI）

名称	必需/可选	数据类型	描述
orgId	必需	String	组织 ID。

请求参数（Body）

名称	必需/可选	数据类型	描述
appId	可选	String	应用 ID。
identifier	可选	String	用户或用户组 ID。
identifierType	可选	Integer	绑定类型。0 为用户，1 为用户组。
ruleIds	必需	List	消息规则 ID 列表。
createdBy	可选	String	消息规则的创建者。

响应参数

名称	数据类型	描述
messageRuleList	MessageRuleDTO 结构体	消息规则列表。

MessageRuleDTO 结构体

名称	数据类型	描述
appId	String	应用 ID。
ruleId	String	消息规则 ID。
ruleName	String	消息规则名称。
relations	relationDTO 结构体	消息规则关联的用户或用户组。
messageRule	Object	消息规则。
isEnable	Integer	规则是否启用。
createdBy	String	创建者。
createdAt	String	创建时间。
updatedBy	String	更新者。
updatedAt	String	更新时间。
deletedBy	String	删除者。
deletedAt	String	删除时间。

relationDTO 结构体

名称	数据类型	描述
type	Integer	类型。0为用户，1为用户组。
identifiers	List	用户或用户组 ID。

错误码

代码	描述
31400	组织 ID 为空。
31404	组织、应用或消息规则不存在，或组织未获取应用。
31600	消息规则内容异常。
31601	用户消息规则数量超过阈值。
31602	规则中 mark 数量超过阈值。
31603	消息规则不匹配。
31604	消息规则 mark 为空。
31607	用户组织结构错误。

示例

请求示例

url: https://{apigw-address}/app-portal-service/v2.2/message-service/rule/search?orgId=your_org_id

method: POST

requestBody:
{
    "appId": "your_app_id",
    "ruleIds": ["your_rule_id_1","your_rule_id_2"],
    "identifier": "your_user_id",
    "identifierType": 0,
    "createdBy": "your_user_id"
}

返回示例

{
    "code": 0,
    "message": "OK",
    "data": {
        "messageRuleList": [
            {
                "appId": "",
                "ruleId": "",
                "ruleName": "",
                "relations": [
                    {
                        "type": 0,
                        "identifiers": ["your_user_id_1","your_user_id_2"]
                    },
                    {
                        "type": 1,
                        "identifiers": ["your_user_group_id"]
                    }
                ],
                "messageRule": {
                    "mark1": ["siteA","siteB"],
                    "mark2": ["deviceA","deviceB"],
                    "mark3": ["fault"],
                    "mark4": [""],
                    "mark6": null
                },
                "isEnable": 1,
                "createdBy": "your_user_id",
                "createdAt": "2021-01-01 00:00:00",
                "updatedBy": "your_user_id",
                "updatedAt": "2021-01-01 00:00:00",
                "deletedAt": null,
                "deletedBy": null
            }
        ]
    }
}