获取活动详情接口

更新时间:2024.12.25

使用场景:商户创建活动后,可以通过该接口查询支付有礼的活动详情,用于管理活动。 可调用商户:商户/服务商/渠道商

# 接口说明

支持商户:
【普通服务商】
请求方式:
【GET】/v3/marketing/paygiftactivity/activities/{activity_id}
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • activity_id 必填 string
    【活动Id】 活动Id

请求示例

GET

# 应答参数

    200OK
  • activity_id 必填 string(20)
    【活动Id】 活动Id
  • activity_type 选填 string
    【活动类型】 活动类型
    可选取值:
    • FULL_SEND_ACT_TYPE: 活动类型
    • STEP_SEND_ACT_TYPE: 活动类型
    • SPECIFIC_SEND_ACT_TYPE: 活动类型
  • activity_base_info 必填 object
    【活动基本信息】 创建活动时录入的基本信息
    • 属性
  • award_send_rule 必填 object
    【活动奖品发放规则】 奖品派送规则,分别对应满送、阶梯送、满A送B中的一种
    • 属性
  • advanced_setting 选填 object
    【活动高级设置】 创建时传入的高级设置信息
    • 属性
  • activity_status 必填 string
    【活动状态】 活动当前状态枚举值
    可选取值:
    • ACT_STATUS_UNKNOWN: 状态未知
    • CREATE_ACT_STATUS: 已创建
    • ONGOING_ACT_STATUS: 运行中
    • TERMINATE_ACT_STATUS: 已终止
    • STOP_ACT_STATUS: 已暂停
    • OVER_TIME_ACT_STATUS: 已过期
    • CREATE_ACT_FAILED: 创建活动失败
  • creator_merchant_id 必填 string(15)
    【创建商户号】 创建商户号
  • belong_merchant_id 必填 string(15)
    【所属商户号】 所属商户号
  • pause_time 选填 string
    【活动暂停时间】 活动暂停时间
  • recovery_time 选填 string
    【活动恢复时间】 活动恢复时间
  • create_time 选填 string
    【活动创建时间】 活动创建时间
  • update_time 选填 string
    【活动更新时间】 活动更新时间

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
400 APPID_MCHID_NOT_MATCH AppID与MchID不匹配 请确认AppID是否正确填写
400 INVALID_REQUEST 请求参数符合参数格式,但不符合业务规则 根据错误提示,传入符合业务规则的参数
400 MCH_NOT_EXISTS 商户号不存在 请确认发券商户号信息是否有误
401 SIGN_ERROR 签名错误或签名信息不完整 登录商户平台核对,传入正确信息
403 NO_AUTH 商户未被授权 登录商户平台核对,传入正确信息
404 RESOURCE_NOT_EXISTS 资源不存在或无可用 请确认资源均存在且可用
429 FREQUENCY_LIMITED 频率超限 请求量不要超过接口调用频率限制
500 SYSTEM_ERROR 系统错误 请使用相同参数稍后重新调用
反馈
咨询
目录

您当前查看的是旧版文档,将于 2025年 3 月 31日 进行下线处理。为了获得最新的内容和产品能力,请点击 [这里] 访问新版文档中心