Notice Message Get¶

Get the details of a notice message.

Prerequisites¶

The OU has obtained the application, or the application is a self-built application in the OU.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	OU ID. How to get orgId >>

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
messageId	Required	String	Message ID.

Response Parameters¶

Name	Data Type	Description
messageId	String	Message ID.
messageType	Number	Message type. `1` means it is a notice message.
appId	String	The application accessKey associated with the message. If the associated application is an external application, it is empty.
appName	Object	External application name. If the associated application is an internal application, it is empty.
url	String	A external link displayed in the message. The end user can jump to the URL by clicking the message title. If `linkedAppId`, `linkedMenuCode`, and `linkedStates` are specified at the same time, only the link specified in the `url` parameter will be displayed.
linkedAppId	String	The application ID associated with the message. The end user can jump to the URL by clicking the message title. `linkedAppId` will be used together with `linkedMenuCode` and `linkedStates` to form the internal URL of Application Portal. If the `url` is specified at the same time, only the link specified in `url` will be displayed. For example: https://{app-service-address}/portal/abc-123-xyz/alarmProcessing?state=site%abc123, where “{app-service-address}” is the environment domain name, “abc-123-xyz” is `linkedAppId`, “alarmProcessing” is `linkedMenuCode`, and “site%abc123” is `linkedStates`.
linkedMenuCode	String	The menu ID within the application that is associated with the message. `linkedMenuCode` will be used together with `linkedAppId` and `linkedStates` to form the URL. For details, see the description of the `linkedAppId` parameter.
linkedStates	String	Other custom parameters in the URL. `linkedStates` will be used together with `linkedAppId` and `linkedMenuCode` to form the URL. For details, see the description of the `linkedAppId` parameter.
features	Object	A multilingual description of the link, displayed in a pop-up window as a supplementary description of the link.
body	Object	Multilingual content of messages.
Header	Object	Multilingual title of message.
tag	List	The message tags to be displayed. Supports multiple languages.
targetType	Map	The type of the message receivers: `0`: All users within the OU. `1`: Specify user.
targets	List	List of user IDs sent by the message.When `targetType` is `0`, this parameter is empty.

Samples¶

Request Sample¶

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

method: POST

requestBody:
{
  "messageId": "yourMessageId"
}

Return Sample¶

{
  "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"}
            }
        ]
        }
    ]
    }
}