员工身份(EIAM)

查询站内通知发送结果

接口

# 权限

身份管理API是以应用维度授权的,在调用接口前需为不同的应用设置接口权限,详情请参考API权限

权限代码 描述
app_notice_msg 应用侧消息通知管理权限
all 全部接口读写权限

# 请求说明

GET https://{your_domain}/api/v2/tenant/notice/insite/{notice_id}/getSendResult

# 请求头

参数名 中文名称 必须 类型 描述
Authorization 授权 String 格式:Bearer {access_token}
Content-Type 内容类型 String 固定值:application/json; charset=utf-8

# 请求示例

# 请求参数

参数名 中文名称 必须 类型 描述
notice_id 通知ID String 通知ID

# 返回示例

成功示例:
HTTP/1.1 200 OK
Content-Type: application/json
{
    "status": "FINISHED"
}


错误示例:
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

# 返回参数

参数名 中文名称 类型 描述
status 发送状态 String UNSENT=未发送
SENDING=发送中
FINISHED=发送完成

# 错误码

状态码 错误码 错误信息 处理措施
400 NOTICE.0001 通知不存在 请检查对应通知是否存在
Notice does not exist