Skip to content

Latest commit

 

History

History
552 lines (420 loc) · 21.3 KB

CommunityChannelModerationApi.md

File metadata and controls

552 lines (420 loc) · 21.3 KB

CommunityChannelModerationApi

All requests use the primary/backup domains configured by the caller.

Method HTTP request Description
addCommunityChannelAllowedSenderList POST /v4/community-channel/allowed-sender-list/add Add community channel allowed sender list
addCommunityChannelMutedUsers POST /v4/community-channel/mute-list/add Add community-channel muted users
getCommunityChannelFreezeList POST /v4/community-channel/freeze-list/get Get community channel freeze status
listCommunityChannelAllowedSenderList POST /v4/community-channel/allowed-sender-list/get List community channel allowed sender list
listCommunityChannelMutedUsers POST /v4/community-channel/mute-list/get List community-channel muted users
removeCommunityChannelAllowedSenderList POST /v4/community-channel/allowed-sender-list/remove Remove community channel allowed sender list
removeCommunityChannelMutedUsers POST /v4/community-channel/mute-list/remove Remove community-channel muted users
setCommunityChannelFreezeList POST /v4/community-channel/freeze-list/set Set community channel freeze list

addCommunityChannelAllowedSenderList

CodeOnlyResponse addCommunityChannelAllowedSenderList(communityChannelAllowedSenderListUpdateRequest)

Add community channel allowed sender list

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelAllowedSenderListUpdateRequest communityChannelAllowedSenderListUpdateRequest = new CommunityChannelAllowedSenderListUpdateRequest(); // CommunityChannelAllowedSenderListUpdateRequest | 
    try {
      CodeOnlyResponse result = apiInstance.addCommunityChannelAllowedSenderList(communityChannelAllowedSenderListUpdateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#addCommunityChannelAllowedSenderList");
      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
communityChannelAllowedSenderListUpdateRequest CommunityChannelAllowedSenderListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

addCommunityChannelMutedUsers

CodeOnlyResponse addCommunityChannelMutedUsers(communityChannelMuteListAddRequest)

Add community-channel muted users

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelMuteListAddRequest communityChannelMuteListAddRequest = new CommunityChannelMuteListAddRequest(); // CommunityChannelMuteListAddRequest | 
    try {
      CodeOnlyResponse result = apiInstance.addCommunityChannelMutedUsers(communityChannelMuteListAddRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#addCommunityChannelMutedUsers");
      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
communityChannelMuteListAddRequest CommunityChannelMuteListAddRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getCommunityChannelFreezeList

CommunityChannelFreezeListGetResponse getCommunityChannelFreezeList(communityChannelFreezeListGetRequest)

Get community channel freeze status

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelFreezeListGetRequest communityChannelFreezeListGetRequest = new CommunityChannelFreezeListGetRequest(); // CommunityChannelFreezeListGetRequest | 
    try {
      CommunityChannelFreezeListGetResponse result = apiInstance.getCommunityChannelFreezeList(communityChannelFreezeListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#getCommunityChannelFreezeList");
      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
communityChannelFreezeListGetRequest CommunityChannelFreezeListGetRequest

Return type

CommunityChannelFreezeListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listCommunityChannelAllowedSenderList

CommunityChannelAllowedSenderListGetResponse listCommunityChannelAllowedSenderList(communityChannelAllowedSenderListGetRequest)

List community channel allowed sender list

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelAllowedSenderListGetRequest communityChannelAllowedSenderListGetRequest = new CommunityChannelAllowedSenderListGetRequest(); // CommunityChannelAllowedSenderListGetRequest | 
    try {
      CommunityChannelAllowedSenderListGetResponse result = apiInstance.listCommunityChannelAllowedSenderList(communityChannelAllowedSenderListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#listCommunityChannelAllowedSenderList");
      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
communityChannelAllowedSenderListGetRequest CommunityChannelAllowedSenderListGetRequest

Return type

CommunityChannelAllowedSenderListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listCommunityChannelMutedUsers

CommunityChannelMuteListGetResponse listCommunityChannelMutedUsers(communityChannelMuteListGetRequest)

List community-channel muted users

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelMuteListGetRequest communityChannelMuteListGetRequest = new CommunityChannelMuteListGetRequest(); // CommunityChannelMuteListGetRequest | 
    try {
      CommunityChannelMuteListGetResponse result = apiInstance.listCommunityChannelMutedUsers(communityChannelMuteListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#listCommunityChannelMutedUsers");
      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
communityChannelMuteListGetRequest CommunityChannelMuteListGetRequest

Return type

CommunityChannelMuteListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

removeCommunityChannelAllowedSenderList

CodeOnlyResponse removeCommunityChannelAllowedSenderList(communityChannelAllowedSenderListUpdateRequest)

Remove community channel allowed sender list

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelAllowedSenderListUpdateRequest communityChannelAllowedSenderListUpdateRequest = new CommunityChannelAllowedSenderListUpdateRequest(); // CommunityChannelAllowedSenderListUpdateRequest | 
    try {
      CodeOnlyResponse result = apiInstance.removeCommunityChannelAllowedSenderList(communityChannelAllowedSenderListUpdateRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#removeCommunityChannelAllowedSenderList");
      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
communityChannelAllowedSenderListUpdateRequest CommunityChannelAllowedSenderListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

removeCommunityChannelMutedUsers

CodeOnlyResponse removeCommunityChannelMutedUsers(communityChannelMuteListRemoveRequest)

Remove community-channel muted users

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelMuteListRemoveRequest communityChannelMuteListRemoveRequest = new CommunityChannelMuteListRemoveRequest(); // CommunityChannelMuteListRemoveRequest | 
    try {
      CodeOnlyResponse result = apiInstance.removeCommunityChannelMutedUsers(communityChannelMuteListRemoveRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#removeCommunityChannelMutedUsers");
      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
communityChannelMuteListRemoveRequest CommunityChannelMuteListRemoveRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

setCommunityChannelFreezeList

CodeOnlyResponse setCommunityChannelFreezeList(communityChannelFreezeListSetRequest)

Set community channel freeze list

Example

// Import classes:
import ai.nexconn.ApiClient;
import ai.nexconn.ApiException;
import ai.nexconn.Configuration;
import ai.nexconn.model.*;
import ai.nexconn.api.CommunityChannelModerationApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sg-light-api.com");
    
    // Configure API key authorization: NexconnSignature
    ApiKeyAuth NexconnSignature = (ApiKeyAuth) defaultClient.getAuthentication("NexconnSignature");
    NexconnSignature.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //NexconnSignature.setApiKeyPrefix("Token");

    CommunityChannelModerationApi apiInstance = new CommunityChannelModerationApi(defaultClient);
    
    CommunityChannelFreezeListSetRequest communityChannelFreezeListSetRequest = new CommunityChannelFreezeListSetRequest(); // CommunityChannelFreezeListSetRequest | 
    try {
      CodeOnlyResponse result = apiInstance.setCommunityChannelFreezeList(communityChannelFreezeListSetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling CommunityChannelModerationApi#setCommunityChannelFreezeList");
      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
communityChannelFreezeListSetRequest CommunityChannelFreezeListSetRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -