Employee Identity (EIAM)
Query In-site Notification Sending Result
Interface
# Permissions
The Identity Management API is authorized at the application level. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.
| Permission Code | Description |
|---|---|
| app_notice_msg | Application-side message notification management permission |
| all | Full interface read and write permissions |
# Request Description
GET https://{your_domain}/api/v2/tenant/notice/insite/{notice_id}/getSendResult
# Request Headers
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| Authorization | Authorization | Yes | String | Format: Bearer {access_token} |
| Content-Type | Content Type | Yes | String | Fixed value: application/json; charset=utf-8 |
# Request Example
None
# Request Parameters
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| notice_id | Notification ID | Yes | String | Notification ID |
# Response Example
Success Example:
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "FINISHED"
}
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": "NOTICE.0001",
"error_msg": "通知不存在"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# Response Parameters
| Parameter | Chinese Name | Type | Description |
|---|---|---|---|
| status | Sending Status | String | UNSENT=Not Sent SENDING=Sending FINISHED=Sent |
# Error Codes
| Status Code | Error Code | Error Message | Handling Action |
|---|---|---|---|
| 400 | NOTICE.0001 | 通知不存在 | Please check if the corresponding notice exists |
| Notice does not exist |