AlipayOpenPublicLabelApi

March 5, 2025 · View on GitHub

All URIs are relative to https://openapi.alipay.com

Method	HTTP request	Description
create	POST /v3/alipay/open/public/label/create	公众号标签管理-添加标签
query	GET /v3/alipay/open/public/label/query	公众号标签管理-查询标签

create

AlipayOpenPublicLabelCreateResponseModel create(alipayOpenPublicLabelCreateModel)

公众号标签管理-添加标签

开发者可以使用该接口创建一个标签，一个服务窗最多同时拥有500个标签，标签名不能重复。

Example

// Import classes:
import com.alipay.v3.ApiClient;
import com.alipay.v3.ApiException;
import com.alipay.v3.Configuration;
import com.alipay.v3.util.*;
import com.alipay.v3.api.models.*;
import com.alipay.v3.api.AlipayOpenPublicLabelApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://openapi.alipay.com");
    // 设置alipayConfig参数（全局设置一次）
    AlipayConfig config = new AlipayConfig();
    config.setAppId("app_id");
    config.setPrivateKey("private_key");
    config.setAlipayPublicKey("alipay_public_key");
    config.setEncryptKey("encrypt_key");
    defaultClient.setAlipayConfig(config);

    AlipayOpenPublicLabelApi apiInstance = new AlipayOpenPublicLabelApi(defaultClient);
    AlipayOpenPublicLabelCreateModel alipayOpenPublicLabelCreateModel = new AlipayOpenPublicLabelCreateModel(); // AlipayOpenPublicLabelCreateModel | 
    try {
      AlipayOpenPublicLabelCreateResponseModel result = apiInstance.create(alipayOpenPublicLabelCreateModel);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayOpenPublicLabelApi#create");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
alipayOpenPublicLabelCreateModel	AlipayOpenPublicLabelCreateModel		[optional]

Return type

AlipayOpenPublicLabelCreateResponseModel

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	common response	-
0	请求失败	-

query

AlipayOpenPublicLabelQueryResponseModel query()

公众号标签管理-查询标签

开发者可以查询该服务窗所有标签值及拥有该标签的用户个数