进展详情查询协议

使用场景：公益侧进提供开放平台接口查询进展相关信息。

调用凭证： 应用签名

请求地址: https://oapi.gongyi.qq.com/api/platform_query_service/GetProcessInfo

请求方法: POST （ HTTPS ）

请求参数:

参数	类型	必填	说明
project_no	string	是	项目ID
process_id	uint32	是	项目进展ID
process_type	uint32	是	进展类型 1-普通/具象化进展 2-透明捐进展 (不传则默认为类型 1；process_id + process_type 唯一)

返回参数:

参数	类型	说明
code	int	返回码：0表示成功，其他值表示错误，请参考错误码说明
msg	string	错误信息
data	object	返回数据

data内容:

参数	类型	长度	说明
img_list	string list	2048	图片列表
video_type	int	-	视频类型: 1-本地上传, 2-视频号, 3-腾讯视频
shipinhao_id	string	128	进展视频视频号id
shipinhao_feeds_id	string	256	进展视频视频号 feeds id
video_url	string	512	视频链接,腾讯视频类型则为vid
video_snapshot	string	512	视频封面
title	string	32	进展标题
address	object list	-	进展执行地，按执行地下标顺序提供，单条数据大小按3KB计算，目前最多20条数据
address[].province	string	32	进展执行地:省
address[].city	string	32	进展执行地:市
address[].area	string	32	进展执行地:区
address[].place_name	string	128	进展的执行地点名称
address[].img_list	string list	4096	执行地的图片列表
address[].content	string	32	执行地的执行内容
address[].people	string[]	65535	受益单位为人时脱敏名称列表；物模版时不需要关注该字段，即为空值
address[].unit	string	16	受益单位物品时执行单位；人模版时不需要关注该字段，即为空值
address[].number	string	16	受益单位物品时执行单位数量；人模版时不需要关注该字段，即为空值
address[].exe_process_donate_people	uint64	16	执行地合捐人数
address[].exe_finish_time	uint64	10	执行地执行完成时间（秒时间戳）
pub_time	string	16	进展发布时间: YYYYMMDD格式
start_time	string	16	进展执行开始时间: YYYYMMDD格式
end_time	string	16	进展执行结束时间: YYYYMMDD格式
perform_cost	string	16	进展整体执行金额，单位：分
helper_object	string	128	受助对象
template_type	string	16	人模版、物模版
process_donate_people	string	16	该进展涉及总的捐赠的人数

请求示例:

{
  "project_no": "233777",
  "process_id": 300303
}

返回示例（人模版）:

{
  "code": 0,
  "msg": "Success",
  "data": {
    "img_list": [
      "https://cdnhost/1.jpg",
      "https://cdnhost/2.jpg"
    ],
    "video_type": 2,
    "shipinhao_id": "xxx",
    "shipinhao_feeds_id": "yyyyyyy",
    "video_url": "https://cdnhost/4.mp4",
    "video_snapshot": "https://cdnhost/3.jpg",
    "title": "zzz",
    "address": [
      {
        "province": "广东省",
        "city": "广州市",
        "area": "海珠区",
        "place_name": "幸福小学",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "people": [
          "赵*一",
          "钱*二"
        ],
        "content": "提供康复训练课"
      },
      {
        "province": "广东省",
        "city": "深圳市",
        "area": "南山区",
        "place_name": "理想小学",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "people": [
          "赵*一",
          "钱*二"
        ],
        "content": "提供康复训练课"
      },
      {
        "province": "海南省",
        "city": "海口市",
        "area": "龙华区",
        "place_name": "快乐村",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "people": [
          "孙*三",
          "李*四"
        ],
        "content": "提供英语训练课"
      }
    ],
    "pub_time": "20230424",
    "start_time": "20230401",
    "end_time": "20230415",
    "perform_cost": "9999999999",
    "helper_object": "乡村小学",
    "template_type": "人模版",
    "process_donate_people": "4300000000"
  }
}

返回示例（物模版）:

{
  "code": 0,
  "msg": "Success",
  "data": {
    "img_list": [
      "https://cdnhost/1.jpg",
      "https://cdnhost/2.jpg"
    ],
    "video_type": 2,
    "shipinhao_id": "xxx",
    "shipinhao_feeds_id": "yyyyyyy",
    "video_url": "https://cdnhost/4.mp4",
    "video_snapshot": "https://cdnhost/3.jpg",
    "title": "zzz",
    "address": [
      {
        "province": "广东省",
        "city": "广州市",
        "area": "海珠区",
        "place_name": "幸福小学",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "unit": "个",
        "number": "1",
        "content": "建成图书角"
      },
      {
        "province": "广东省",
        "city": "深圳市",
        "area": "南山区",
        "place_name": "理想小学",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "unit": "个",
        "number": "1",
        "content": "建成图书角"
      },
      {
        "province": "广东省",
        "city": "佛山市",
        "area": "禅城区",
        "place_name": "石湾第一小学",
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg",
          "https://cdnhost/3.jpg"
        ],
        "unit": "节",
        "number": "2",
        "content": "开展月度课程"
      }
    ],
    "pub_time": "20230424",
    "start_time": "20230401",
    "end_time": "20230415",
    "perform_cost": "9999999999",
    "helper_object": "乡村小学",
    "template_type": "物模版",
    "process_donate_people": "4300000000"
  }
}

注：返回http status为非200均需要重试。

进展列表查询协议

使用场景：公益侧进提供开放平台接口查询进展列表相关信息。

调用凭证： 应用签名

请求地址: https://oapi.gongyi.qq.com/api/platform_query_service/GetProcessInfoList

请求方法: POST （ HTTPS ）

请求参数:

参数	类型	必填	说明
project_no	string	是	项目ID
pub_time_begin	string	否	进展发布时间过滤开始时间: YYYYMMDD格式
pub_time_end	string	否	进展发布时间过滤截止时间: YYYYMMDD格式

返回参数:

参数	类型	说明
code	int	返回码：0表示成功，其他值表示错误，请参考错误码说明
msg	string	错误信息
data	object	返回数据

data内容:

参数	类型	长度	说明
process_list	object list	-	进展列表
process_list[].process_id	uint32	-	项目进展ID
process_list[].img_list	string list	2048	图片列表
process_list[].video_type	int	-	视频类型: 1-本地上传, 2-视频号, 3-腾讯视频
process_list[].shipinhao_id	string	128	进展视频视频号id
process_list[].shipinhao_feeds_id	string	256	进展视频视频号 feeds id
process_list[].video_url	string	512	视频链接,腾讯视频类型则为vid
process_list[].video_snapshot	string	512	视频封面
process_list[].title	string	32	进展标题
process_list[].address	object list	-	进展执行地，按执行地下标顺序提供，单条数据大小按3KB计算，目前最多20条数据
process_list[].address[].province	string	32	进展执行地:省
process_list[].address[].city	string	32	进展执行地:市
process_list[].address[].area	string	32	进展执行地:区
process_list[].address[].place_name	string	128	进展的执行地点名称
process_list[].address[].img_list	string list	4096	执行地的图片列表
process_list[].address[].content	string	32	执行地的执行内容
process_list[].address[].people	string[]	65535	受益单位为人时脱敏名称列表；物模版时不需要关注该字段，即为空值
process_list[].address[].unit	string	16	受益单位物品时执行单位；人模版时不需要关注该字段，即为空值
process_list[].address[].number	uint32	16	受益单位物品时执行单位数量；人模版时不需要关注该字段，即为空值
process_list[].pub_time	string	16	进展发布时间: YYYYMMDD格式
process_list[].start_time	string	16	进展执行开始时间: YYYYMMDD格式
process_list[].end_time	string	16	进展执行结束时间: YYYYMMDD格式
process_list[].perform_cost	string	16	进展整体执行金额，单位：分
process_list[].helper_object	string	128	受助对象
process_list[].template_type	string	16	人模版、物模版
process_list[].process_donate_people	string	16	该进展涉及总的捐赠的人数

请求示例:

{
  "project_no": "233777",
  "pub_time_begin": "20230420",
  "pub_time_end": "20230421"
}

返回示例:

{
  "code": 0,
  "msg": "Success",
  "data": {
    "process_list": [
      {
        "process_id": 300303,
        "img_list": [
          "https://cdnhost/1.jpg",
          "https://cdnhost/2.jpg"
        ],
        "video_type": 2,
        "shipinhao_id": "xxx",
        "shipinhao_feeds_id": "yyyyyyy",
        "video_url": "https://cdnhost/4.mp4",
        "video_snapshot": "https://cdnhost/3.jpg",
        "title": "zzz",
        "address": [
          {
            "province": "广东省",
            "city": "广州市",
            "area": "海珠区",
            "place_name": "幸福小学",
            "img_list": [
              "https://cdnhost/1.jpg",
              "https://cdnhost/2.jpg",
              "https://cdnhost/3.jpg"
            ],
            "unit": "个",
            "number": "1",
            "content": "建成图书角"
          },
          {
            "province": "广东省",
            "city": "深圳市",
            "area": "南山区",
            "place_name": "快乐村",
            "img_list": [
              "https://cdnhost/1.jpg",
              "https://cdnhost/2.jpg",
              "https://cdnhost/3.jpg"
            ],
            "unit": "节",
            "number": "2",
            "content": "开展月度课程"
          }
        ],
        "pub_time": "20230424",
        "start_time": "20230401",
        "end_time": "20230415",
        "perform_cost": "9999999999",
        "helper_object": "乡村小学",
        "template_type": "物模版",
        "process_donate_people": "4300000000"
      }
    ]
  }
}

注：返回http status为非200均需要重试。

查询指定日期区间的项目执行内容统计

使用场景：公益侧进提供开放平台接口查询指定日期区间的项目执行内容统计。

调用凭证： 应用签名

请求地址: https://oapi.gongyi.qq.com/api/platform_query_service/GetProcessExeStat

请求方法: POST （ HTTPS ）

请求参数:

参数	类型	必填	说明
project_no	string	是	项目ID
begin_date	string	是	查询开始日期, YYYYMMDD格式
end_date	string	否	查询结束日期, YYYYMMDD格式, 不填表示查到当天

返回参数:

参数	类型	说明
code	int	返回码：0表示成功，其他值表示错误，请参考错误码说明
msg	string	错误信息
data	object	返回数据

data内容:

参数	类型	长度	说明
helper_info	object list	-	执行统计列表
helper_info[].content	string	32	执行内容物模版：执行内容人模版：帮助+受助对象
helper_info[].unit	string	16	执行单位，物模版按进展执行地填写的单位取人模版固定展示为：位
helper_info[].number	uint32	16	执行单位，物模版按进展执行地填写的单位取

请求示例:

{
  "project_no": "123456",
  "begin_date": "20230601",
  "end_date": "20230701"
}

返回示例:

{
  "code": 0,
  "msg": "Success",
  "data": {
    "helper_info": [
      {
        "content": "建成图书馆",
        "unit": "座",
        "number": 100
      },
      {
        "content": "购买图书",
        "unit": "本",
        "number": 9999
      },
      {
        "content": "帮助困境儿童",
        "unit": "位",
        "number": 9999
      }
    ]
  }
}

注：返回http status为非200均需要重试。

data.code 错误码如下，该错误码为逻辑内部错误，其中参数错误需要检查请求参数，其他错误均为逻辑内部错误。

错误码	错误描述
10030019	系统错误
10030001	参数错误
30110238	具像化数据校验错误

进展详情查询协议

进展列表查询协议

查询指定日期区间的项目执行内容统计

results matching ""

No results matching ""

results matching ""

No results matching ""