获取通知信息
功能介绍
获取通知信息。
调用方法
请参见如何调用API。
URI
GET /v1/task/notification/{task_id}
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
codeGateFailed |
TaskEventNotificationParam object |
参数解释： 门禁失败。 取值范围： 不涉及。 |
|
deleteTask |
TaskEventNotificationParam object |
参数解释： 删除任务。 取值范围： 不涉及。 |
|
executeTask |
TaskEventNotificationParam object |
参数解释： 任务检查完成。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
roles |
String |
参数解释: 接收者角色。 取值范围: 不涉及 |
|
sendMail |
Boolean |
参数解释: 是否开启邮件通知。 取值范围: true开启；false不开启。 |
|
sendMessage |
Boolean |
参数解释: 是否开启消息通知。 取值范围: true开启；false不开启。 |
|
sendOfficialAccount |
Boolean |
参数解释: 是否开启公众号通知。 取值范围: true开启；false不开启。 |
|
sendRolesEnable |
Boolean |
参数解释: 是否发送给指定的角色。 取值范围: true开启；false不开启。 |
|
sendUsersEnable |
Boolean |
参数解释: 是否发送给指定的用户。 取值范围: true开启；false不开启。 |
|
userIds |
String |
参数解释: 用户列表，用户ID用英文逗号隔开。 取值范围: 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
查询id为897acf5exxx48a5013cd的最新一次消息通知。
https://{endpoint}/v1/task/notification/897acf5exxx48a5013cd
null
响应示例
状态码：200
Request succeeded!
{
"codeGateFailed" : {
"roles" : "Developer",
"sendMail" : true,
"sendMessage" : true,
"sendOfficialAccount" : false,
"sendRolesEnable" : true,
"sendUsersEnable" : true,
"userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
},
"deleteTask" : {
"roles" : "Developer",
"sendMail" : true,
"sendMessage" : true,
"sendOfficialAccount" : false,
"sendRolesEnable" : true,
"sendUsersEnable" : true,
"userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
},
"executeTask" : {
"roles" : "Developer",
"sendMail" : true,
"sendMessage" : true,
"sendOfficialAccount" : false,
"sendRolesEnable" : true,
"sendUsersEnable" : true,
"userIds" : "e8d32c5f742448228fd2ec78bdee72e4"
}
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
