【泛知识】回调通知
介绍
在添加/修改商品,上传商品资源,以及检测到不合规的商品后,课程库会将结果进行回调通知。需要开发者先通过解决方案配置对应消息通知地址,并且按照如下请求返回结构,实现对应消息处理开发。
请求头
参数名 | 参数类型 | 备注 |
---|---|---|
Content-Type | string | 请求的MIME类型,统一为application/json |
请求体
商品上传,商品修改,商品下架(内部审核不通过)操作的通知信息
参数名 | 参数类型 | 备注 | 示例 |
---|---|---|---|
produce_id | string | 商品id | "1234abc" |
produce_name | string | 商品名称 | "课程1" |
produce_status | enum | 商品状态 | -1 |
produce_examine_res | bool | 商品审核结果 | false |
reason | object | 商品审核不通过原因 | { "课程上传失败": [ "课程收费不符合标准" , "课程中存在违法信息" , ] } |
notice_type | enum | 通知类型 | 1 |
developer_flag | string | 确定我方身份唯一的标志(开发者自定义)0<len<=255 | "902398182034" |
callback_data | string | 自定义字段 | "123qwr" |
商品资源上传的通知信息
参数名 | 参数类型 | 备注 | 示例 |
---|---|---|---|
resource_tos_uri | string | 商品资源唯一 | "product/resource/79436cc6fe83362149d" |
produce_source_status | enum | 商品资源状态 | -1 |
produce_source_examine_res | bool | 商品资源上传结果 | false |
reason | object | 商品资源上传失败的原因 | { "资源上传失败 ": [ "资源中存在违法信息" , ] } |
notice_type | enum | 通知类型 | 4 |
developer_flag | string | 我方身份唯一的标志 | "902398182034" |
callback_data | string | 自定义字段 | "123qwr" |
教师和机构资质的认证与修改操作的通知信息
参数名 | 参数类型 | 备注 | 示例 |
---|---|---|---|
object_id | string | 商品id | "T2343143214" |
object_name | string | 商品名称 | "教师" |
produce_status | enum | 商品状态 | -1 |
produce_examine_res | bool | 商品审核结果 | false |
reason | object | 商品审核不通过原因 | { "教师认证失败": [ "身份证信息不够清晰" ] } |
notice_type | enum | 通知类型 | 11 |
developer_flag | string | 确定我方身份唯一的标志 | "902398182034" |
callback_data | string | 自定义字段 | "123qwr" |
履约内容审核的通知信息的通知信息
参数名 | 参数类型 | 备注 | 示例 |
---|---|---|---|
produce_id | string | 商品id | "23232343143214" |
produce_name | string | 商品名称 | "课程名称" |
audit_status | enum | 履约内容审核状态 | 3 |
resource_uri | string | 履约内容uri | "product/resource/1231223344" |
reason | string | 履约内容审核不通过原因 | "禁入课程" |
position | string | 履约审核不通过位置 | "音频" |
notice_type | enum | 通知类型 | 31 |
developer_flag | string | 确定我方身份唯一的标志 | "902398182034" |
callback_data | string | 自定义字段 | "123qwr" |
响应(response)
返回的状态码必须为 200,其他状态码一律视为回调通知失败
响应体
参数名 | 参数类型 | 是否必传 | 备注 | 示例 |
---|---|---|---|---|
err_no | number | 是 | 错误码,0为成功 | 0 |
err_tips | string | 是 | 错误内容 | "success" |
示例
{
"err_tips": "success",
"err_no": 0
}
注:响应信息需严格按照格式返回,若接收成功时将 err_no 置为 0,若失败时需将 err_no 置为任意非 0 值,同时保证 err_tips 不为空,返回有效错误提示;若响应信息不合法,将发起回调重试
参数说明
produce_status(商品状态)
商品状态 | 枚举值 |
---|---|
已生效 | 1 |
未生效 | -1 |
produce_examine_res(商品审核结果)
商品状态 | bool值 |
---|---|
审核通过 | true |
审核未通过 | false |
audit_status(履约内容审核结果)
履约内容审核状态 | 枚举值 |
---|---|
审核中 | 1 |
审核成功 | 2 |
审核失败 | 3 |
produce_source_status(商品资源状态)
商品资源状态 | 枚举值 |
---|---|
已上传 | 1 |
未上传 | -1 |
produce_source_examine_res(商品资源审核结果)
商品资源状态 | bool值 |
---|---|
审核通过 | true |
审核未通过 | false |
notice_type(通知类型)
课程库相关通知
通知类型 | 枚举值 |
---|---|
课程入库通知 | 1 |
课程修改通知 | 2 |
课程下架通知(巡查不通过,监控不通过) | 3 |
资源上传 | 4 |
视频审核通知(视频审核不通过时会导致课程下架) | 31 |
资质审核相关通知
通知类型 | 枚举值 |
---|---|
教师资质认证通知 | 11 |
教师资质修改修改通知 | 12 |
机构资质认证通知 | 13 |
机构资质修改通知 | 14 |
示例
商品上传通知请求
{
"developer_flag": "1234abc",
"notice_type": 1,
"produce_examine_res": false,
"produce_id": 1,
"produce_name": "produce1",
"produce_status": -1,
"callback_data": "aabb1",
"reason": {
"商品上传失败": ["课程存在违法信息", "课程价格不合理"]
}
}
商品修改(商品已生效)通知请求
{
"developer_flag": "1234abc",
"notice_type": 2,
"produce_examine_res": false,
"produce_id": 1,
"produce_name": "produce1",
"produce_status": 1,
"callback_data": "aabb1",
"reason": {
"商品修改失败": ["课程存在违法信息", "课程价格不合理"]
}
}
商品下架(内部审核不通过才通知)通知请求
{
"developer_flag": "1234abc",
"notice_type": 3,
"produce_examine_res": false,
"produce_id": 1,
"produce_name": "produce1",
"produce_status": -1,
"callback_data": "aabb1",
"reason": {
"商品审核不通过": ["课程存在违法信息", "课程价格不合理"]
}
}
商品资源通知请求
{
"developer_flag":"123abc",
"notice_type":4,
"produce_source_examine_res":false,
"produce_source_status":-1,
"resource_tos_uri": "product/app1/source1"
"callback_data":"aabb1",
"reason":{
"商品资源上传失败":[
"资源存在违法信息",
]
}
}
教师资质认证通知请求
{
"developer_flag": "1234abc",
"notice_type": 11,
"produce_examine_res": false,
"object_id": "T243252323423",
"object_name": "老师",
"produce_status": -1,
"callback_data": "aabb1",
"reason": {
"教师资质认证失败": ["教师关键信息缺失"]
}
}
履约内容审核回调
{
"developer_flag": "1234abc",
"notice_type": 31,
"produce_id": "35424324",
"produce_name": "produce1",
"resource_uri": "product/resource/2342312",
"audit_status": 2,
"callback_data": "aabb1",
"reason": "禁入课程",
"position": "音频"
}