Skip to content

Latest commit

 

History

History
106 lines (83 loc) · 4.54 KB

AlipayMarketingActivityAppApi.md

File metadata and controls

106 lines (83 loc) · 4.54 KB

AlipaySDKNet.OpenAPI.Api.AlipayMarketingActivityAppApi

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

Method HTTP request Description
Batchquery GET /v3/alipay/marketing/activity/{activity_id}/app/batchquery 查询活动可用小程序

Batchquery

AlipayMarketingActivityAppBatchqueryResponseModel Batchquery (string activityId, string merchantId = null, int? pageNum = null, string pageSize = null, string merchantAccessMode = null)

查询活动可用小程序

通过此接口可查询活动的可用小程序,判断活动是否在该小程序可用，来决定是否展示。

Example

using System.Collections.Generic;
using System.Diagnostics;
using AlipaySDKNet.OpenAPI.Api;
using AlipaySDKNet.OpenAPI.Client;
using AlipaySDKNet.OpenAPI.Model;
using AlipaySDKNet.OpenAPI.Util;
using AlipaySDKNet.OpenAPI.Util.Model;

namespace Example
{
    public class BatchqueryExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://openapi.alipay.com";
            var apiInstance = new AlipayMarketingActivityAppApi(config);

            // 设置alipayConfig参数
            AlipayConfig alipayConfig = new AlipayConfig();
            alipayConfig.AppId = "app_id";
            alipayConfig.PrivateKey = "private_key";
            // 密钥模式
            alipayConfig.AlipayPublicKey = "alipay_public_key";
            // 证书模式
            // alipayConfig.AppCertPath = "../appCertPublicKey.crt";
            // alipayConfig.AlipayPublicCertPath = "../alipayCertPublicKey_RSA2.crt";
            // alipayConfig.RootCertPath = "../alipayRootCert.crt";
            alipayConfig.EncryptKey = "encrypt_key";
            AlipayConfigUtil alipayConfigUtil = new AlipayConfigUtil(alipayConfig);
            apiInstance.Client.SetAlipayConfigUtil(alipayConfigUtil);

            var activityId = 2016042700826004508401111111;  // string | 活动id
            var merchantId = 2088202967380463;  // string | 商户PID,默认为当前接口调用商户  限制:  接口调用者必须有商户代运营权限。  <a href=\"https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83\">代运营授权流程</a> (optional) 
            var pageNum = 1;  // int? | 分页查询页码。  限制: 必须为大于0的整数 (optional) 
            var pageSize = 20;  // string | 分页查询单页数据条数。  限制:  1.必须为大于0的整数  2.每页最大值为20 (optional) 
            var merchantAccessMode = AGENCY_MODE;  // string | 商户接入模式 (optional) 

            try
            {
                // 查询活动可用小程序
                AlipayMarketingActivityAppBatchqueryResponseModel result = apiInstance.Batchquery(activityId, merchantId, pageNum, pageSize, merchantAccessMode);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling AlipayMarketingActivityAppApi.Batchquery: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
activityId string 活动id
merchantId string 商户PID,默认为当前接口调用商户 限制: 接口调用者必须有商户代运营权限。 <a href=&quot;https://opendocs.alipay.com/mini/01hm6i#%E4%BB%A3%E8%BF%90%E8%90%A5%E6%8E%88%E6%9D%83\&quot;&gt;代运营授权流程&lt;/a> [optional]
pageNum int? 分页查询页码。 限制: 必须为大于0的整数 [optional]
pageSize string 分页查询单页数据条数。 限制: 1.必须为大于0的整数 2.每页最大值为20 [optional]
merchantAccessMode string 商户接入模式 [optional]

Return type

AlipayMarketingActivityAppBatchqueryResponseModel

Authorization

No authorization required

HTTP request headers

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

HTTP response details

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

[Back to top] [Back to API list] [Back to README]