批量查询用户联合投放配置

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/marketing/joint-delivery/users/delivery-configs/batch-get?identifier_type=USER_IDENTIFIER_TYPE_OPENID&user_identifiers=oUasdgxuAJO_M2pxb1Q9zNjWeS6o \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

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 BatchGetUserJointDeliveryConfig {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/brand/marketing/joint-delivery/users/delivery-configs/batch-get";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    BatchGetUserJointDeliveryConfig client = new BatchGetUserJointDeliveryConfig(
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    BatchGetUserJointDeliveryConfigRequest request = new BatchGetUserJointDeliveryConfigRequest();
41    request.identifierType = UserIdentifierType.USER_IDENTIFIER_TYPE_OPENID;
42    request.userIdentifiers = new ArrayList<>();
43{
44  request.userIdentifiers.add("oUasdgxuAJO_M2pxb1Q9zNjWeS6o");
45};
46    try {
47      BatchGetUserJointDeliveryConfigResponse response = client.run(request);
48        // TODO: 请求成功，继续业务逻辑
49        System.out.println(response);
50    } catch (WXPayBrandUtility.ApiException e) {
51        // TODO: 请求失败，根据状态码执行不同的逻辑
52        e.printStackTrace();
53    }
54  }
55
56  public BatchGetUserJointDeliveryConfigResponse run(BatchGetUserJointDeliveryConfigRequest request) {
57    String uri = PATH;
58    Map<String, Object> args = new HashMap<>();
59    args.put("identifier_type", request.identifierType);
60    args.put("user_identifiers", request.userIdentifiers);
61    String queryString = WXPayBrandUtility.urlEncode(args);
62    if (!queryString.isEmpty()) {
63        uri = uri + "?" + queryString;
64    }
65
66    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
67    reqBuilder.addHeader("Accept", "application/json");
68    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
69    reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null));
70    reqBuilder.method(METHOD, null);
71    Request httpRequest = reqBuilder.build();
72
73    // 发送HTTP请求
74    OkHttpClient client = new OkHttpClient.Builder().build();
75    try (Response httpResponse = client.newCall(httpRequest).execute()) {
76      String respBody = WXPayBrandUtility.extractBody(httpResponse);
77      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
78        // 2XX 成功，验证应答签名
79        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
80            httpResponse.headers(), respBody);
81
82        // 从HTTP应答报文构建返回数据
83        return WXPayBrandUtility.fromJson(respBody, BatchGetUserJointDeliveryConfigResponse.class);
84      } else {
85        throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
86      }
87    } catch (IOException e) {
88      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
89    }
90  }
91
92  private final String brand_id;
93  private final String certificateSerialNo;
94  private final PrivateKey privateKey;
95  private final String wechatPayPublicKeyId;
96  private final PublicKey wechatPayPublicKey;
97
98  public BatchGetUserJointDeliveryConfig(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
99    this.brand_id = brand_id;
100    this.certificateSerialNo = certificateSerialNo;
101    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
102    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
103    this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
104  }
105
106  public static class BatchGetUserJointDeliveryConfigRequest {
107    @SerializedName("user_identifiers")
108    @Expose(serialize = false)
109    public List<String> userIdentifiers = new ArrayList<String>();
110  
111    @SerializedName("identifier_type")
112    @Expose(serialize = false)
113    public UserIdentifierType identifierType;
114  }
115  
116  public static class BatchGetUserJointDeliveryConfigResponse {
117    @SerializedName("user_configs")
118    public List<UserJointDeliveryConfigResponse> userConfigs = new ArrayList<UserJointDeliveryConfigResponse>();
119  }
120  
121  public enum UserIdentifierType {
122    @SerializedName("USER_IDENTIFIER_TYPE_OPENID")
123    USER_IDENTIFIER_TYPE_OPENID,
124    @SerializedName("USER_IDENTIFIER_TYPE_PHONE_MD5")
125    USER_IDENTIFIER_TYPE_PHONE_MD5
126  }
127  
128  public static class UserJointDeliveryConfigResponse {
129    @SerializedName("user_identifier")
130    public String userIdentifier;
131  
132    @SerializedName("plan_ids")
133    public List<String> planIds;
134  
135    @SerializedName("update_time")
136    public String updateTime;
137  
138    @SerializedName("error_code")
139    public String errorCode;
140  
141    @SerializedName("error_message")
142    public String errorMessage;
143  }
144  
145}
146

1package main
2
3import (
4	"demo/wxpay_brand_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/brand/4015826866
5	"encoding/json"
6	"fmt"
7	"net/http"
8	"net/url"
9)
10
11func main() {
12	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
13	config, err := wxpay_brand_utility.CreateBrandConfig(
14		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
15		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
16		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
17		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
18		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
19	)
20	if err != nil {
21		fmt.Println(err)
22		return
23	}
24
25	request := &BatchGetUserJointDeliveryConfigRequest{
26		IdentifierType:  USERIDENTIFIERTYPE_USER_IDENTIFIER_TYPE_OPENID.Ptr(),
27		UserIdentifiers: []string{"oUasdgxuAJO_M2pxb1Q9zNjWeS6o"},
28	}
29
30	response, err := BatchGetUserJointDeliveryConfig(config, request)
31	if err != nil {
32		fmt.Printf("请求失败: %+v\n", err)
33		// TODO: 请求失败，根据状态码执行不同的处理
34		return
35	}
36
37	// TODO: 请求成功，继续业务逻辑
38	fmt.Printf("请求成功: %+v\n", response)
39}
40
41func BatchGetUserJointDeliveryConfig(config *wxpay_brand_utility.BrandConfig, request *BatchGetUserJointDeliveryConfigRequest) (response *BatchGetUserJointDeliveryConfigResponse, err error) {
42	const (
43		host   = "https://api.mch.weixin.qq.com"
44		method = "GET"
45		path   = "/brand/marketing/joint-delivery/users/delivery-configs/batch-get"
46	)
47
48	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
49	if err != nil {
50		return nil, err
51	}
52	query := reqUrl.Query()
53	if request.IdentifierType != nil {
54		query.Add("identifier_type", fmt.Sprintf("%v", *request.IdentifierType))
55	}
56	if request.UserIdentifiers != nil {
57		query.Add("user_identifiers", fmt.Sprintf("%v", *request.UserIdentifiers))
58	}
59	reqUrl.RawQuery = query.Encode()
60	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
61	if err != nil {
62		return nil, err
63	}
64	httpRequest.Header.Set("Accept", "application/json")
65	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
66	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
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 := &BatchGetUserJointDeliveryConfigResponse{}
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 BatchGetUserJointDeliveryConfigRequest struct {
108	UserIdentifiers []string            `json:"user_identifiers,omitempty"`
109	IdentifierType  *UserIdentifierType `json:"identifier_type,omitempty"`
110}
111
112func (o *BatchGetUserJointDeliveryConfigRequest) MarshalJSON() ([]byte, error) {
113	type Alias BatchGetUserJointDeliveryConfigRequest
114	a := &struct {
115		UserIdentifiers []string            `json:"user_identifiers,omitempty"`
116		IdentifierType  *UserIdentifierType `json:"identifier_type,omitempty"`
117		*Alias
118	}{
119		// 序列化时移除非 Body 字段
120		UserIdentifiers: nil,
121		IdentifierType:  nil,
122		Alias:           (*Alias)(o),
123	}
124	return json.Marshal(a)
125}
126
127type BatchGetUserJointDeliveryConfigResponse struct {
128	UserConfigs []UserJointDeliveryConfigResponse `json:"user_configs,omitempty"`
129}
130
131type UserIdentifierType string
132
133func (e UserIdentifierType) Ptr() *UserIdentifierType {
134	return &e
135}
136
137const (
138	USERIDENTIFIERTYPE_USER_IDENTIFIER_TYPE_OPENID    UserIdentifierType = "USER_IDENTIFIER_TYPE_OPENID"
139	USERIDENTIFIERTYPE_USER_IDENTIFIER_TYPE_PHONE_MD5 UserIdentifierType = "USER_IDENTIFIER_TYPE_PHONE_MD5"
140)
141
142type UserJointDeliveryConfigResponse struct {
143	UserIdentifier *string  `json:"user_identifier,omitempty"`
144	PlanIds        []string `json:"plan_ids,omitempty"`
145	UpdateTime     *string  `json:"update_time,omitempty"`
146	ErrorCode      *string  `json:"error_code,omitempty"`
147	ErrorMessage   *string  `json:"error_message,omitempty"`
148}
149