Notice Message Get¶

获取待办消息详情。

前提条件¶

OU 已获取当前应用，或当前应用为 OU 内自建应用。

请求格式¶

POST https://{apigw-address}/app-portal/api/v3/notice-message/get

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
messageId	必需	String	消息 ID。

响应参数¶

名称	数据类型	描述
messageId	String	消息 ID。
messageType	Number	消息类型。`1` 表示待办消息。
appId	String	消息关联的应用 accessKey。若关联应用为外部应用，则为空。
appName	Object	外部应用名称。若关联应用为内部应用，则为空。
url	String	消息随附链接。终端用户在弹窗中点击消息标题即可跳转至 URL。若同时通过 `linkedAppId`、`linkedMenuCode` 和 `linkedStates` 指定了链接，将仅展示当前参数赋值的链接。
linkedAppId	String	与消息关联的应用 ID。`linkedAppId` 将与 `linkedMenuCode` 和 `linkedStates` 一起构成跳转链接 URL，可用于指定应用门户内部链接。终端用户在弹窗中点击消息标题即可跳转至 URL。若同时在 `url` 参数中指定连接，将仅展示 `url` 中指定的链接。例如：https://{app-service-address}/portal/abc-123-xyz/alarmProcessing?state=site%abc123，其中，“{app-service-address}” 是环境域名，“abc-123-xyz”为 `linkedAppId`，“alarmProcessing”为 `linkedMenuCode`，“site%abc123”为 `linkedStates`。
linkedMenuCode	String	与消息关联的应用内的菜单 ID。`linkedMenuCode` 将与 `linkedAppId` 和 `linkedStates` 一起构成跳转链接 URL，详情见 `linkedAppId` 参数的描述。
linkedStates	String	URL 中的其它自定义参数。`linkedStates` 将与 `linkedAppId` 和 `linkedMenuCode` 一起构成跳转链接 URL，详情见 `linkedAppId` 参数的描述。
features	Object	链接的多语言描述，展示在弹窗内作为链接的补充说明。
body	Object	消息的多语言内容。
Header	Object	消息的多语言标题。
tag	List	展示的消息标签，支持多语言。
targetType	Map	消息发送对象的目标类型： `0`：OU 内全体用户。 `1`：指定用户。
targets	List	消息发送的用户 ID 列表。当 `targetType` 为 `0` 时为空。

示例¶

请求示例¶

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

method: POST

requestBody:
{
  "messageId": "yourMessageId"
}

返回示例¶

{
  "code": 0,
  "message": "",
  "data": {
    "messages": [
        {
        "messageId": "yourMessageId",
        "messageType": 1,
        "url": "http://xxx.com",
        "targetType": 1,
        "targets": ["u123", "u456"],
        "appId": "yourAppAccessKey",
        "appName": {
            "defaultValue": "appName",
            "i18nValue": {"zh_CN": "appNameZh", "en_US": "appNameEn"}
        },
        "header": {
            "defaultValue": "header",
            "i18nValue": {"zh_CN": "headerZh", "en_US": "headerEn"}
        },
        "body": {
            "defaultValue": "body",
            "i18nValue": {"zh_CN": "bodyZh", "en_US": "bodyEn"}
        },
        "tags": [
            {
            "defaultValue": "tag1",
            "i18nValue": {"zh_CN": "tag1Zh", "en_US": "tag1En"}
            },
            {
            "defaultValue": "tag2",
            "i18nValue": {"zh_CN": "tag2Zh", "en_US": "tag2En"}
            }
        ],
        "features": [
            {
            "defaultValue": "feature1",
            "i18nValue": {"zh_CN": "feature1Zh", "en_US": "feature1En"}
            },
            {
            "defaultValue": "feature2",
            "i18nValue": {"zh_CN": "feature2Zh", "en_US": "feature2En"}
            }
        ]
        }
    ]
    }
}