执行情况推送(腾讯公益为被调)
接口名称
PostExeInfo
使用场景
项目卡片筹款满后需要机构按时执行,并将执行结果反馈推送至腾讯公益侧。
请求地址
https://oapi.gongyi.qq.com/api/tmj_third_service/PostExeInfo
请求方式
POST
请求参数
header参数
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
Gy-H-Api-Appid | string | 采用签名认证方式时,必填 | 应用id,由开放平台分配给应用的唯一ID |
Gy-H-Api-Nonce-Str | string | 采用签名认证方式时,必填 | 随机值,可以是数字和字母的组合;长度32位;应用侧生成,保证唯一即可 |
Gy-H-Api-Timestamp | uint32 | 采用签名认证方式时,必填 | 时间戳,单位s |
Gy-H-Api-Sign | string | 采用签名认证方式时,必填 | 使用应用的密钥,通过HMAC-SHA256算法签名后,得出的结果,详见签名说明 |
post参数
参数 | 类型 | 长度 | 是否必填 | 说明 |
---|---|---|---|---|
proc_id | string | 20位字符 | 否 | 进展id,带本字段则认为是更新操作,如果是反馈到人,只允许对单个进展更新 |
proc_type | uint32 | 10位字符 | 是 | 进展类型:1-反馈进展,2-实时统计数据 |
project_id | uint32 | 10位字符 | 是 | 项目id |
project_name | string | 18位字符 | 是 | 项目名称 |
match_type | uint32 | 10位字符 | 是 | 反馈目标维度,1-受助组织维度,2-受助人维度 |
card_id | string | 20位字符 | 是 | 目标卡片id,一个项目下唯一(目标导入接口有返回) |
exe_money | string | 10位字符 | 否 | 本次进展执行的善款金额,如没有使用善款,则无须填写,单位元(match_type为1时填写;match_type为2时同时需要填写help_list.money,后台会做校验) |
exe_images | array | - | 是 | 本次进展执行照片,url字符串数组,3张原图 每张图片大小不要超过 20M |
help_org_number | string | 30位字符 | 是 | 受助组织机构id,如:学校id |
help_org_name | string | 30位字符 | 否 | 受助组织机构名称,如:学校名称 |
exe_content | string | 100位字符 | 是 | 执行内容 |
exe_date | string | 40位字符 | 是 | 执行时间到秒,如:2006年1月2日 15:04:05 |
real_time_exe | object | - | 否 | 组织实时反馈(设备类的实时反馈数据) |
real_time_exe.id | string | - | 否 | 设备id,如:净水器设备id |
real_time_exe.data_day | string | - | 否 | 设备天数据,如:10 |
real_time_exe.data_month | string | - | 否 | 设备月数据,如:100 |
real_time_exe.data_total | string | - | 否 | 设备累计数据:如:2300 |
real_time_exe.unit_name | string | - | 否 | 设备单位名称,如:升 |
real_time_exe.data_date | string | - | 否 | 数据更新时间,如:2006年1月2日 15:04:05 |
help_list | array | - | 是 | 受助人列表(反馈目标到“2-受助人维度”,才必填) |
help_list.stu_id | string | 30位字符 | 是 | 受助人id(反馈目标到“2-受助人维度”,才必填) |
help_list.stu_name | string | 30位字符 | 是 | 受助人姓名(全名,对外展示时会脱敏)(筹款目标到“2-受助人维度”,才必填) |
help_list.stu_id_change | string | 30位字符 | 否 | 更换后的受助人id |
help_list.stu_name_change | string | 30位字符 | 否 | 更换后的受助人姓名(脱敏) |
help_list.change_reason | string | 100位字符 | 否 | 更换原因 |
help_list.stu_age | uint32 | 4位字符 | 否 | 受助人年龄 |
help_list.stu_sex | string | 2位字符 | 否 | 受助人性别,如:男、女 |
help_list.school_date | string | 30位字符 | 否 | 受助人入学时间,如:2024年3月1日 |
help_list.school_grade_class | string | 30位字符 | 否 | 受助人所在年级、班级,如:一年级五班 |
help_list.stu_home_situation | string | 100位字符 | 否 | 受助人家庭情况 |
help_list.stu_disease_situation | string | 100位字符 | 否 | 受助人疾病情况 |
help_list.stu_funding_options | string | 100位字符 | 否 | 对受助人的资助意见 |
help_list.money | string | 30位字符 | 是 | 对受助人的资助标准(金额/元,如有小数最多保留两位)人执行金额,单位元,受助人反馈进展时需要填写,且进展总金额要填入到外层的exe_money字段 |
help_list.exe_content | string | 100位字符 | 是 | 受助人执行内容 |
help_list.exe_date | string | 40位字符 | 是 | 受助人执行时间到秒,如:2023年12月12日 00:00:00 |
need_manage_fee | int32 | - | 否 | 是否展示管理费: 0-不展示 1-展示包含管理费 |
返回参数
参数 | 类型 | 说明 |
---|---|---|
code | int32 | 返回码 |
msg | string | 返回信息 |
data | object | 回包数据 |
data.proc_id | string | 进展id,全局唯一;实时反馈如感动器数据无此字段返回。 |
trace_id | string | 链路Id,用于问题定位 |
示例
POST https://test-oapi.gongyi.qq.com/api/tmj_third_service/PostExeInfo
请求包体
{
"project_id": 50000001,
"project_name": "为乡村学生送出美术包",
"match_type": 2,
"proc_type": 1,
"card_id": "10001",
"help_org_number": "100010001",
"help_org_name": "南山实验小学",
"exe_images": [
"https://abc.png",
"https://abc2.png",
"https://abc3.png"
],
"exe_money":"200",
"exe_content": "",
"exe_date": "2023年12月12日 00:00:00",
"help_list": [
{
"stu_id": "1",
"stu_name": "张三",
"exe_content": "收到一个美术包",
"exe_date": "2023年12月30日",
"money":"100"
},
{
"stu_id": "2",
"stu_name": "李四",
"exe_content": "收到一个美术包",
"exe_date": "2023年12月30日",
"money":"100"
}
]
}
返回包体
{
"code": 0,
"msg": "",
"data":{
"proc_id": "10001"
},
"trace_id":"1234567890987654321"
}
请求包体2
{
"project_id": 50000002,
"project_name": "为乡村学校学生发放助学金",
"match_type": 2,
"proc_type": 1,
"card_id": "10002",
"help_org_number": "100010002",
"help_org_name": "员村小学",
"exe_images": [
"https://abc.png",
"https://abc2.png",
"https://abc3.png"
],
"help_list": [
{
"stu_id": "1",
"stu_name": "张三",
"exe_content": "提取800元到个人银行卡",
"exe_date": "2023年12月30日 12:23:08"
},
{
"stu_id": "2",
"stu_name": "李四",
"exe_content": "提取800元到个人银行卡",
"exe_date": "2023年12月31日 12:23:08"
}
]
}
返回包体2
{
"code": 0,
"msg": "",
"data":{
"proc_id": "10001"
},
"trace_id":"1234567890987654321"
}
请求包体3
{
"project_id": 50000003,
"project_name": "为听障儿童提供耳蜗升级",
"match_type": 2,
"proc_type": 1,
"card_id": "10003",
"help_org_number": "100010002",
"help_org_name": "员村小学",
"exe_images": [
"https://abc.png",
"https://abc2.png",
"https://abc3.png"
],
"help_list": [
{
"stu_id": "1",
"stu_name": "张三",
"exe_content": "在山东省济宁市任城区知音听力助听器验配中心,更换升级体外机",
"exe_date": "2023年12月21日"
},
{
"stu_id": "2",
"stu_name": "李四",
"exe_content": "在山东省济宁市任城区知音听力助听器验配中心,更换升级体外机",
"exe_date": "2023年12月21日"
}
]
}
返回包体3
{
"code": 0,
"msg": "",
"data":{
"proc_id": "10001"
},
"trace_id":"1234567890987654321"
}
请求包体4
{
"project_id": 50000004,
"project_name": "为乡村学校开展净水计划",
"match_type": 1,
"proc_type": 1,
"card_id": "10004",
"help_org_number": "100010002",
"help_org_name": "员村小学",
"exe_content": "安装了1台净水设备",
"exe_money": "40000",
"exe_date": "2023年12月12日 00:00:00",
"exe_images": [
"https://abc.png",
"https://abc2.png",
"https://abc3.png"
]
}
{
"project_id": 50000004,
"project_name": "为乡村学校开展净水计划",
"proc_type": 2,
"card_id": "10004",
"real_time_exe": {
"id":"xxxxxx1",
"data_day":"10",
"data_month":"100",
"data_total":"2300",
"unit_name":"升",
"data_date":"2023年12月12日 01:00:00"
}
}
返回包体 4
{
"code": 0,
"msg": "",
"data":{
"proc_id": "10001"
},
"trace_id":"1234567890987654321"
}