Files
cunkebao_v3/Server/extend/alipay-sdk-all/v3/docs/Api/AlipayOpenPublicLabelApi.md

147 lines
4.4 KiB
Markdown
Raw Normal View History

2025-03-12 12:18:06 +08:00
# Alipay\OpenAPISDK\AlipayOpenPublicLabelApi
All URIs are relative to https://openapi.alipay.com.
Method | HTTP request | Description
------------- | ------------- | -------------
[**create()**](AlipayOpenPublicLabelApi.md#create) | **POST** /v3/alipay/open/public/label/create | 公众号标签管理-添加标签
[**query()**](AlipayOpenPublicLabelApi.md#query) | **GET** /v3/alipay/open/public/label/query | 公众号标签管理-查询标签
## `create()`
```php
create($alipayOpenPublicLabelCreateModel): \Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelCreateResponseModel
```
公众号标签管理-添加标签
开发者可以使用该接口创建一个标签一个服务窗最多同时拥有500个标签标签名不能重复。
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenPublicLabelApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);
$alipayOpenPublicLabelCreateModel = new \Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelCreateModel(); // \Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelCreateModel
try {
$result = $apiInstance->create($alipayOpenPublicLabelCreateModel);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AlipayOpenPublicLabelApi->create: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**alipayOpenPublicLabelCreateModel** | **\Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelCreateModel**| | [optional]
### Return type
**\Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelCreateResponseModel**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: `application/json`
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#api-endpoints)
[[Back to README]](../../README.md)
## `query()`
```php
query(): \Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelQueryResponseModel
```
公众号标签管理-查询标签
开发者可以查询该服务窗所有标签值及拥有该标签的用户个数
### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Alipay\OpenAPISDK\Api\AlipayOpenPublicLabelApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
// 初始化alipay参数
$alipayConfig = new \Alipay\OpenAPISDK\Util\Model\AlipayConfig();
$alipayConfig->setAppId('app_id');
$alipayConfig->setPrivateKey('private_key');
// 密钥模式
$alipayConfig->setAlipayPublicKey('alipay_public_key');
// 证书模式
// $alipayConfig->setAppCertPath('../appCertPublicKey.crt');
// $alipayConfig->setAlipayPublicCertPath('../alipayCertPublicKey_RSA2.crt');
// $alipayConfig->setRootCertPath('../alipayRootCert.crt');
$alipayConfig->setEncryptKey('encrypt_key');
$alipayConfigUtil = new \Alipay\OpenAPISDK\Util\AlipayConfigUtil($alipayConfig);
$apiInstance->setAlipayConfigUtil($alipayConfigUtil);
try {
$result = $apiInstance->query();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AlipayOpenPublicLabelApi->query: ', $e->getMessage(), PHP_EOL;
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
**\Alipay\OpenAPISDK\Model\AlipayOpenPublicLabelQueryResponseModel**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: `application/json`
[[Back to top]](#) [[Back to API list]](../../README.md#api-endpoints)
[[Back to README]](../../README.md)