AlipayOpenPublicPersonalizedMenuApi

March 5, 2025 · View on GitHub

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

MethodHTTP requestDescription
createPOST /v3/alipay/open/public/personalized/menu/create个性化菜单创建
deleteDELETE /v3/alipay/open/public/personalized/menu/delete个性化菜单删除

create

AlipayOpenPublicPersonalizedMenuCreateResponseModel create(alipayOpenPublicPersonalizedMenuCreateModel)

个性化菜单创建

开发者可使用该接口创建个性化菜单,当生活号用户标签信息命中该菜单的标签规则时,用户将会看到该套菜单。个性化菜单创建完成后立即生效,用户支付宝客户端版本低于10.0.12时,若创建的是icon菜单,也会以文本菜单的形式展示。

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.AlipayOpenPublicPersonalizedMenuApi;

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);

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

Parameters

NameTypeDescriptionNotes
alipayOpenPublicPersonalizedMenuCreateModelAlipayOpenPublicPersonalizedMenuCreateModel[optional]

Return type

AlipayOpenPublicPersonalizedMenuCreateResponseModel

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status codeDescriptionResponse headers
200common response-
0请求失败-

delete

Object delete(menuKey)

个性化菜单删除

开发者可使用该接口删除个性化菜单

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.AlipayOpenPublicPersonalizedMenuApi;

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);

    AlipayOpenPublicPersonalizedMenuApi apiInstance = new AlipayOpenPublicPersonalizedMenuApi(defaultClient);
    String menuKey = "100000"; // String | 要删除的个性化菜单key。通过 <a href=\"https://opendocs.alipay.com/apis/api_6/alipay.open.public.personalized.menu.create\">alipay.open.public.personalized.menu.create</a>(个性化菜单创建)接口创建个性化菜单后获取。
    try {
      Object result = apiInstance.delete(menuKey);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayOpenPublicPersonalizedMenuApi#delete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
menuKeyString要删除的个性化菜单key。通过 <a href=&quot;https://opendocs.alipay.com/apis/api_6/alipay.open.public.personalized.menu.create\&quot;&gt;alipay.open.public.personalized.menu.create&lt;/a&gt;(个性化菜单创建)接口创建个性化菜单后获取。[optional]

Return type

Object

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200common response-
0请求失败-