扩充人群包
更新时间:2025.09.29面向品牌商家的人群包扩充任务,完成人群包文件上传后,使用人群包资源请求扩充人群包,接口会将对应资源内容扩充到指定人群包。
注:上传后不会立即生效,需等候数据同步,通常需要T+2。
前置条件:已创建人群包,已上传人群包文件
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/user-package/user-packages/{user_package_id}/expand
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
path 路径参数
user_package_id 必填 string(20)
【人群包ID】 人群包ID,请联系微信支付运营获取。
body 包体参数
upload_id 必填 string(128)
【上传ID】 上传ID,调用初始化上传时返回的上传ID
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/user-package/user-packages/01000100010000000007/expand \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "upload_id" : "17587186700323d11ac17d8d3d4c8c4e5a250c3e804977e89af6a05ffa93751d0ec0179ca8" 9 }' 10
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 扩充人群包 24 */ 25public class ExpandUserPackage { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/brand/marketing/user-package/user-packages/{user_package_id}/expand"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 ExpandUserPackage client = new ExpandUserPackage( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 ExpandUserPackageRequest request = new ExpandUserPackageRequest(); 41 request.userPackageId = "01000100010000000007"; 42 request.uploadId = "17587186700323d11ac17d8d3d4c8c4e5a250c3e804977e89af6a05ffa93751d0ec0179ca8"; 43 try { 44 ExpandUserPackageResponse response = client.run(request); 45 // TODO: 请求成功,继续业务逻辑 46 System.out.println(response); 47 } catch (WXPayBrandUtility.ApiException e) { 48 // TODO: 请求失败,根据状态码执行不同的逻辑 49 e.printStackTrace(); 50 } 51 } 52 53 public ExpandUserPackageResponse run(ExpandUserPackageRequest request) { 54 String uri = PATH; 55 uri = uri.replace("{user_package_id}", WXPayBrandUtility.urlEncode(request.userPackageId)); 56 String reqBody = WXPayBrandUtility.toJson(request); 57 58 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 59 reqBuilder.addHeader("Accept", "application/json"); 60 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 61 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 62 reqBuilder.addHeader("Content-Type", "application/json"); 63 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 64 reqBuilder.method(METHOD, requestBody); 65 Request httpRequest = reqBuilder.build(); 66 67 // 发送HTTP请求 68 OkHttpClient client = new OkHttpClient.Builder().build(); 69 try (Response httpResponse = client.newCall(httpRequest).execute()) { 70 String respBody = WXPayBrandUtility.extractBody(httpResponse); 71 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 72 // 2XX 成功,验证应答签名 73 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 74 httpResponse.headers(), respBody); 75 76 // 从HTTP应答报文构建返回数据 77 return WXPayBrandUtility.fromJson(respBody, ExpandUserPackageResponse.class); 78 } else { 79 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 80 } 81 } catch (IOException e) { 82 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 83 } 84 } 85 86 private final String brand_id; 87 private final String certificateSerialNo; 88 private final PrivateKey privateKey; 89 private final String wechatPayPublicKeyId; 90 private final PublicKey wechatPayPublicKey; 91 92 public ExpandUserPackage(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 93 this.brand_id = brand_id; 94 this.certificateSerialNo = certificateSerialNo; 95 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 96 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 97 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 98 } 99 100 public static class ExpandUserPackageRequest { 101 @SerializedName("user_package_id") 102 @Expose(serialize = false) 103 public String userPackageId; 104 105 @SerializedName("upload_id") 106 public String uploadId; 107 } 108 109 public static class ExpandUserPackageResponse { 110 @SerializedName("return_message") 111 public String returnMessage; 112 113 @SerializedName("state") 114 public UserPackageProcessState state; 115 } 116 117 public enum UserPackageProcessState { 118 @SerializedName("USER_PACKAGE_PROCESS_STATE_PROCESSING") 119 USER_PACKAGE_PROCESS_STATE_PROCESSING, 120 @SerializedName("USER_PACKAGE_PROCESS_STATE_FINISHED") 121 USER_PACKAGE_PROCESS_STATE_FINISHED, 122 @SerializedName("USER_PACKAGE_PROCESS_STATE_FAILED") 123 USER_PACKAGE_PROCESS_STATE_FAILED 124 } 125 126} 127
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "strings" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 15 config, err := wxpay_brand_utility.CreateBrandConfig( 16 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 17 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 18 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &ExpandUserPackageRequest{ 28 UserPackageId: wxpay_brand_utility.String("01000100010000000007"), 29 UploadId: wxpay_brand_utility.String("17587186700323d11ac17d8d3d4c8c4e5a250c3e804977e89af6a05ffa93751d0ec0179ca8"), 30 } 31 32 response, err := ExpandUserPackage(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func ExpandUserPackage(config *wxpay_brand_utility.BrandConfig, request *ExpandUserPackageRequest) (response *ExpandUserPackageResponse, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "POST" 47 path = "/brand/marketing/user-package/user-packages/{user_package_id}/expand" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{user_package_id}", url.PathEscape(*request.UserPackageId), -1) 55 reqBody, err := json.Marshal(request) 56 if err != nil { 57 return nil, err 58 } 59 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest.Header.Set("Accept", "application/json") 64 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 65 httpRequest.Header.Set("Content-Type", "application/json") 66 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Authorization", authorization) 71 72 client := &http.Client{} 73 httpResponse, err := client.Do(httpRequest) 74 if err != nil { 75 return nil, err 76 } 77 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 78 if err != nil { 79 return nil, err 80 } 81 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 82 // 2XX 成功,验证应答签名 83 err = wxpay_brand_utility.ValidateResponse( 84 config.WechatPayPublicKeyId(), 85 config.WechatPayPublicKey(), 86 &httpResponse.Header, 87 respBody, 88 ) 89 if err != nil { 90 return nil, err 91 } 92 response := &ExpandUserPackageResponse{} 93 if err := json.Unmarshal(respBody, response); err != nil { 94 return nil, err 95 } 96 97 return response, nil 98 } else { 99 return nil, wxpay_brand_utility.NewApiException( 100 httpResponse.StatusCode, 101 httpResponse.Header, 102 respBody, 103 ) 104 } 105} 106 107type ExpandUserPackageRequest struct { 108 UserPackageId *string `json:"user_package_id,omitempty"` 109 UploadId *string `json:"upload_id,omitempty"` 110} 111 112func (o *ExpandUserPackageRequest) MarshalJSON() ([]byte, error) { 113 type Alias ExpandUserPackageRequest 114 a := &struct { 115 UserPackageId *string `json:"user_package_id,omitempty"` 116 *Alias 117 }{ 118 // 序列化时移除非 Body 字段 119 UserPackageId: nil, 120 Alias: (*Alias)(o), 121 } 122 return json.Marshal(a) 123} 124 125type ExpandUserPackageResponse struct { 126 ReturnMessage *string `json:"return_message,omitempty"` 127 State *UserPackageProcessState `json:"state,omitempty"` 128} 129 130type UserPackageProcessState string 131 132func (e UserPackageProcessState) Ptr() *UserPackageProcessState { 133 return &e 134} 135 136const ( 137 USERPACKAGEPROCESSSTATE_USER_PACKAGE_PROCESS_STATE_PROCESSING UserPackageProcessState = "USER_PACKAGE_PROCESS_STATE_PROCESSING" 138 USERPACKAGEPROCESSSTATE_USER_PACKAGE_PROCESS_STATE_FINISHED UserPackageProcessState = "USER_PACKAGE_PROCESS_STATE_FINISHED" 139 USERPACKAGEPROCESSSTATE_USER_PACKAGE_PROCESS_STATE_FAILED UserPackageProcessState = "USER_PACKAGE_PROCESS_STATE_FAILED" 140) 141
应答参数
200 OK
return_message 必填 string(128)
【 返回信息】 返回信息,扩充人群包任务提交成功后,返回成功信息;扩充人群包任务失败后,返回失败提示信息。
state 必填 string
【任务状态】 上传任务的状态。由于扩充人群包任务需要等待数据同步,因此状态为 PROCESSING 时,不代表扩充任务已完成。但可以认为扩充任务已成功提交,请等待数据同步完成。
可选取值
USER_PACKAGE_PROCESS_STATE_PROCESSING
: 扩充人群包任务处理中,请等待,非终态。USER_PACKAGE_PROCESS_STATE_FINISHED
: 扩充人群包任务已处理完成,任务上传的文件中的用户已导入到人群包中,终态。USER_PACKAGE_PROCESS_STATE_FAILED
: 扩充人群包任务失败,请稍后重试,终态。
应答示例
200 OK
1{ 2 "return_message" : "success", 3 "state" : "USER_PACKAGE_PROCESS_STATE_PROCESSING" 4} 5
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 传入参数不符合业务规则 | 请参考文档中对每个字段的要求以及组合要求,确认请求参数是否满足 |
403 | NO_AUTH | 缺少业务相关权限 | 请确认具备人群包操作权限 |
404 | NOT_FOUND | 未找到 user_package_id 对应的人群包 | 请确认 user_package_id 存在且属于当前品牌 |
429 | RATELIMIT_EXCEEDED | 请求超过接口频率限制 | 请稍后使用原参数重试 |