Skip to content

Latest commit

 

History

History
228 lines (179 loc) · 7.76 KB

AlipayIserviceCcmInstanceApi.md

File metadata and controls

228 lines (179 loc) · 7.76 KB

AlipayIserviceCcmInstanceApi

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

Method HTTP request Description
create POST /v3/alipay/iservice/ccm/instance/create 创建租户实例
get GET /v3/alipay/iservice/ccm/instance/get 查询单个租户实例（数据权限）
query GET /v3/alipay/iservice/ccm/instance/query 列出所有的租户实例（数据权限）

create

AlipayIserviceCcmInstanceCreateResponseModel create(alipayIserviceCcmInstanceCreateModel)

创建租户实例

创建租户实例

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

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

    AlipayIserviceCcmInstanceApi apiInstance = new AlipayIserviceCcmInstanceApi(defaultClient);
    AlipayIserviceCcmInstanceCreateModel alipayIserviceCcmInstanceCreateModel = new AlipayIserviceCcmInstanceCreateModel(); // AlipayIserviceCcmInstanceCreateModel | 
    try {
      AlipayIserviceCcmInstanceCreateResponseModel result = apiInstance.create(alipayIserviceCcmInstanceCreateModel);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayIserviceCcmInstanceApi#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
alipayIserviceCcmInstanceCreateModel AlipayIserviceCcmInstanceCreateModel [optional]

Return type

AlipayIserviceCcmInstanceCreateResponseModel

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 请求失败 -

get

AlipayIserviceCcmInstanceGetResponseModel get(id, externalId)

查询单个租户实例（数据权限）

查询单个租户实例（数据权限）

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

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

    AlipayIserviceCcmInstanceApi apiInstance = new AlipayIserviceCcmInstanceApi(defaultClient);
    String id = "pYv_gs0m"; // String | 部门id（即租户实例ID、数据权限ID）
    String externalId = "5544744"; // String | 外部id
    try {
      AlipayIserviceCcmInstanceGetResponseModel result = apiInstance.get(id, externalId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayIserviceCcmInstanceApi#get");
      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
id String 部门id（即租户实例ID、数据权限ID） [optional]
externalId String 外部id [optional]

Return type

AlipayIserviceCcmInstanceGetResponseModel

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 请求失败 -

query

AlipayIserviceCcmInstanceQueryResponseModel query(pageNum, pageSize)

列出所有的租户实例（数据权限）

列出所有的租户实例（数据权限）。一个云客服租户下可以有多个租户实例（数据权限），每个租户实例之间的数据是隔离的（除了用户、权限、私信、IVR数据外）。

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

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

    AlipayIserviceCcmInstanceApi apiInstance = new AlipayIserviceCcmInstanceApi(defaultClient);
    Integer pageNum = 1; // Integer | 查询结果的页码，起始值为 1，默认值为 1
    Integer pageSize = 10; // Integer | 分页查询时设置的每页记录数，最大值 100 行，默认为 10
    try {
      AlipayIserviceCcmInstanceQueryResponseModel result = apiInstance.query(pageNum, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AlipayIserviceCcmInstanceApi#query");
      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
pageNum Integer 查询结果的页码，起始值为 1，默认值为 1 [optional]
pageSize Integer 分页查询时设置的每页记录数，最大值 100 行，默认为 10 [optional]

Return type

AlipayIserviceCcmInstanceQueryResponseModel

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 请求失败 -