- 支付
- 私域
- 公域
- 营销
- 资金
- 会员
- 信用
- 安全
- 其他
券领取通知
公共请求参数#
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
notify_id | String | 必选 | 50 | 通知ID | 5608cccc09ddb39d41c2e3c06e3d9fejh2 |
utc_timestamp | String | 必选 | 13 | 消息发送时的服务端时间 | 1514210452731 |
msg_method | String | 必选 | 100 | 消息接口名称 | alipay.marketing.activity.message.received |
app_id | String | 必选 | 20 | 消息接受方的应用id | 2014060600164699 |
msg_type | String | 可选 | 5 | 消息类型。目前支持类型:sys:系统消息;usr,用户消息;app,应用消息 | sys |
msg_app_id | String | 可选 | 20 | 消息归属方的应用id。应用消息时非空 | 2016032301002387 |
version | String | 必选 | 5 | 版本号(1.1版本为标准消息) | 1.0或者1.1 |
biz_content | String | 必选 | 消息报文 | 参见具体的消息接口文档 | |
sign | String | 必选 | 签名 | WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93joTW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY= | |
sign_type | String | 必选 | 10 | 签名类型 | RSA2 |
encrypt_type | String | 可选 | 10 | 加密算法 | AES |
charset | String | 必选 | 10 | 编码集,该字符集为验签和解密所需要的字符集 | UTF-8 |
notify_type | String | 可选 | 20 | [1.0版本老协议参数]通知类型,1.1接口没有该参数 | trade_status |
notify_time | String | 可选 | 19 | [1.0版本老协议参数]通知时间,北京时区,时间格式为:yyyy-MM-dd HH:mm:ss,如果服务器部署在国外请注意做时区转换。若version=1.1则可以使用utc_timestamp识别时间 | 1970-01-01 00:00:00 |
auth_app_id | String | 可选 | 20 | [1.0版本老协议参数]授权方的应用id | 2016032301002387 |
消息属性#
参数中文名 | 参数英文名 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|---|
幂等号 | id | String | 必选 | 128 | 事件id。可用于业务去重。 | RECEIVED_2021042400826001508407723739 |
活动 id | activity_id | String | 必选 | 128 | 活动id | 2016042700826004508401111111 |
事件创建时间 | event_time | String | 必选 | 64 | 事件创建时间。注意事项精确到毫秒。返回的时间是long型的时间戳字符串,可用于消息的乱序处理。 | 1619338271 |
支付宝券id | voucher_id | String | 必选 | 32 | 用户券 id。支付宝为用户优惠券唯一分配的 id。 | 2021072900073002214009F8QHR3 |
券码 | voucher_code | String | 可选 | 64 | 用户领取的券码code,支付宝商家券活动才会返回券码,其他优惠券活动该值为空 | ABE44 |
领券的支付宝user_id | receive_user_id | String | 必选 | 64 | 领券的支付宝user_id账号想了解openid? | 2088010101120 |
领券的支付宝用户union_id | receive_union_id | String | 可选 | 47 | 领券的支付宝用户union_id。 union_id是支付宝用户在开放平台的唯一标识符,在配置应用 分组后会返回该值。 union_id在同一分组内应用保持一致。 | 092aSPrsmhTbexLh9zgoYb2uvZNC4D8izCpGKTem8QiIOQb |
响应值#
响应值 | 描述 | 是否重试 |
---|---|---|
fail | 消息获取失败 | 是 |
success | 消息获取成功 | 否 |
消息示例#