Skip to content

Latest commit

 

History

History
638 lines (481 loc) · 23.3 KB

File metadata and controls

638 lines (481 loc) · 23.3 KB

GroupChannelModerationApi

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

Method HTTP request Description
addGroupChannelAllowedSenderList POST /v4/group-channel/allowed-sender-list/add Add to allowed senders list
addGroupChannelFreezeList POST /v4/group-channel/freeze-list/add Freeze a group
addGroupChannelUserMuteList POST /v4/group-channel/user/mute-list/add Mute a group member
getGroupChannelAllowedSenderList POST /v4/group-channel/allowed-sender-list/get Query allowed senders list
getGroupChannelFreezeList POST /v4/group-channel/freeze-list/get Query group freeze status
getGroupChannelUserMuteList POST /v4/group-channel/user/mute-list/get List muted group members
removeGroupChannelAllowedSenderList POST /v4/group-channel/allowed-sender-list/remove Remove from allowed senders list
removeGroupChannelFreezeList POST /v4/group-channel/freeze-list/remove Unfreeze a group
removeGroupChannelUserMuteList POST /v4/group-channel/user/mute-list/remove Unmute a group member

addGroupChannelAllowedSenderList

CodeOnlyResponse addGroupChannelAllowedSenderList(groupChannelAllowedSenderListUpdateRequest)

Add to allowed senders list

Rate limit: 100/sec.

Example

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

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

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

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 -

addGroupChannelFreezeList

CodeOnlyResponse addGroupChannelFreezeList(groupChannelFreezeListUpdateRequest)

Freeze a group

Rate limit: 100/sec.

Example

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

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

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

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 -

addGroupChannelUserMuteList

CodeOnlyResponse addGroupChannelUserMuteList(groupChannelUserMuteListAddRequest)

Mute a group member

Rate limit: 100/sec.

Example

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

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

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

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 -

getGroupChannelAllowedSenderList

GroupChannelAllowedSenderListGetResponse getGroupChannelAllowedSenderList(groupChannelAllowedSenderListGetRequest)

Query allowed senders list

Rate limit: 100/sec.

Example

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

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

    GroupChannelModerationApi apiInstance = new GroupChannelModerationApi(defaultClient);
    
    GroupChannelAllowedSenderListGetRequest groupChannelAllowedSenderListGetRequest = new GroupChannelAllowedSenderListGetRequest(); // GroupChannelAllowedSenderListGetRequest | 
    try {
      GroupChannelAllowedSenderListGetResponse result = apiInstance.getGroupChannelAllowedSenderList(groupChannelAllowedSenderListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelModerationApi#getGroupChannelAllowedSenderList");
      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
groupChannelAllowedSenderListGetRequest GroupChannelAllowedSenderListGetRequest

Return type

GroupChannelAllowedSenderListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getGroupChannelFreezeList

GroupChannelFreezeListGetResponse getGroupChannelFreezeList(groupChannelFreezeListGetRequest)

Query group freeze status

Rate limit: 100/sec.

Example

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

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

    GroupChannelModerationApi apiInstance = new GroupChannelModerationApi(defaultClient);
    
    GroupChannelFreezeListGetRequest groupChannelFreezeListGetRequest = new GroupChannelFreezeListGetRequest(); // GroupChannelFreezeListGetRequest | 
    try {
      GroupChannelFreezeListGetResponse result = apiInstance.getGroupChannelFreezeList(groupChannelFreezeListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelModerationApi#getGroupChannelFreezeList");
      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
groupChannelFreezeListGetRequest GroupChannelFreezeListGetRequest

Return type

GroupChannelFreezeListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

getGroupChannelUserMuteList

GroupChannelUserMuteListGetResponse getGroupChannelUserMuteList(groupChannelUserMuteListGetRequest)

List muted group members

Rate limit: 100/sec. The public endpoint list currently publishes this capability as `/v4/group-channel/user/mute-list-get`.

Example

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

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

    GroupChannelModerationApi apiInstance = new GroupChannelModerationApi(defaultClient);
    
    GroupChannelUserMuteListGetRequest groupChannelUserMuteListGetRequest = new GroupChannelUserMuteListGetRequest(); // GroupChannelUserMuteListGetRequest | 
    try {
      GroupChannelUserMuteListGetResponse result = apiInstance.getGroupChannelUserMuteList(groupChannelUserMuteListGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelModerationApi#getGroupChannelUserMuteList");
      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
groupChannelUserMuteListGetRequest GroupChannelUserMuteListGetRequest

Return type

GroupChannelUserMuteListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

removeGroupChannelAllowedSenderList

CodeOnlyResponse removeGroupChannelAllowedSenderList(groupChannelAllowedSenderListUpdateRequest)

Remove from allowed senders list

Rate limit: 100/sec.

Example

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

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

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

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 -

removeGroupChannelFreezeList

CodeOnlyResponse removeGroupChannelFreezeList(groupChannelFreezeListUpdateRequest)

Unfreeze a group

Rate limit: 100/sec.

Example

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

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

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

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 -

removeGroupChannelUserMuteList

CodeOnlyResponse removeGroupChannelUserMuteList(groupChannelUserMuteListRemoveRequest)

Unmute a group member

Rate limit: 100/sec.

Example

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

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

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

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 -