GroupChannelManagementApi

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

Method	HTTP request	Description
addGroupChannelAdmins	POST /v4/group-channel/admin/add	Add group admins
addGroupChannelMemberFavorites	POST /v4/group-channel/member/favorites/add	Add favorite group members
batchGetGroupChannelMembers	POST /v4/group-channel/member/batch/get	Get specific group members
batchGetGroupChannelProfiles	POST /v4/group-channel/profile/list	List group profiles
createGroupChannel	POST /v4/group-channel/create	Create a group
deleteGroupChannelAlias	POST /v4/group-channel/alias/delete	Delete group alias
dismissGroupChannel	POST /v4/group-channel/dismiss	Dismiss a group
getGroupChannelAlias	POST /v4/group-channel/alias/get	Get group alias
joinGroupChannel	POST /v4/group-channel/join	Join a group
kickUserFromAllGroupChannels	POST /v4/group-channel/member/kickout-all	Remove a user from all groups
listGroupChannelMemberFavorites	POST /v4/group-channel/member/favorites/list	List favorite group members
listGroupChannelMembers	POST /v4/group-channel/member/list	Query group members
listGroupChannels	POST /v4/group-channel/list	List group channels
listUserJoinedGroupChannels	POST /v4/group-channel/joined/list	Query user's groups
quitGroupChannel	POST /v4/group-channel/leave	Leave a group
removeGroupChannelAdmins	POST /v4/group-channel/admin/remove	Remove group admins
removeGroupChannelMemberFavorites	POST /v4/group-channel/member/favorites/remove	Remove favorite group members
setGroupChannelAlias	POST /v4/group-channel/alias/set	Set group alias
setGroupChannelMember	POST /v4/group-channel/member/set	Set group member profile
transferGroupChannelOwner	POST /v4/group-channel/transfer/owner	Transfer group ownership
updateGroupChannelProfile	POST /v4/group-channel/profile/update	Update group info

addGroupChannelAdmins

CodeOnlyResponse addGroupChannelAdmins(groupChannelAdminUsersRequest)

Add group admins

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

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

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

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	-

addGroupChannelMemberFavorites

CodeOnlyResponse addGroupChannelMemberFavorites(groupChannelMemberFavoritesUpdateRequest)

Add favorite group members

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

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

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

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	-

batchGetGroupChannelMembers

GroupChannelMemberBatchGetResponse batchGetGroupChannelMembers(groupChannelMemberBatchGetRequest)

Get specific group members

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelMemberBatchGetRequest groupChannelMemberBatchGetRequest = new GroupChannelMemberBatchGetRequest(); // GroupChannelMemberBatchGetRequest | 
    try {
      GroupChannelMemberBatchGetResponse result = apiInstance.batchGetGroupChannelMembers(groupChannelMemberBatchGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#batchGetGroupChannelMembers");
      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
groupChannelMemberBatchGetRequest	GroupChannelMemberBatchGetRequest

Return type

GroupChannelMemberBatchGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

batchGetGroupChannelProfiles

GroupChannelProfileListResponse batchGetGroupChannelProfiles(groupChannelProfileListRequest)

List group profiles

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelProfileListRequest groupChannelProfileListRequest = new GroupChannelProfileListRequest(); // GroupChannelProfileListRequest | 
    try {
      GroupChannelProfileListResponse result = apiInstance.batchGetGroupChannelProfiles(groupChannelProfileListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#batchGetGroupChannelProfiles");
      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
groupChannelProfileListRequest	GroupChannelProfileListRequest

Return type

GroupChannelProfileListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

createGroupChannel

CodeOnlyResponse createGroupChannel(groupChannelCreateRequest)

Create 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.GroupChannelManagementApi;

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

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

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	-

deleteGroupChannelAlias

CodeOnlyResponse deleteGroupChannelAlias(groupChannelAliasGetRequest)

Delete group alias

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

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

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

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	-

dismissGroupChannel

CodeOnlyResponse dismissGroupChannel(groupChannelDismissRequest)

Dismiss 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.GroupChannelManagementApi;

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

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

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	-

getGroupChannelAlias

GroupChannelAliasGetResponse getGroupChannelAlias(groupChannelAliasGetRequest)

Get group alias

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelAliasGetRequest groupChannelAliasGetRequest = new GroupChannelAliasGetRequest(); // GroupChannelAliasGetRequest | 
    try {
      GroupChannelAliasGetResponse result = apiInstance.getGroupChannelAlias(groupChannelAliasGetRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#getGroupChannelAlias");
      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
groupChannelAliasGetRequest	GroupChannelAliasGetRequest

Return type

GroupChannelAliasGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

joinGroupChannel

GroupChannelJoinResponse joinGroupChannel(groupChannelJoinRequest)

Join 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.GroupChannelManagementApi;

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelJoinRequest groupChannelJoinRequest = new GroupChannelJoinRequest(); // GroupChannelJoinRequest | 
    try {
      GroupChannelJoinResponse result = apiInstance.joinGroupChannel(groupChannelJoinRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#joinGroupChannel");
      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
groupChannelJoinRequest	GroupChannelJoinRequest

Return type

GroupChannelJoinResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

kickUserFromAllGroupChannels

CodeOnlyResponse kickUserFromAllGroupChannels(groupChannelKickUserFromAllRequest)

Remove a user from all groups

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

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

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

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	-

listGroupChannelMemberFavorites

GroupChannelMemberFavoritesListResponse listGroupChannelMemberFavorites(groupChannelMemberFavoritesListRequest)

List favorite group members

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelMemberFavoritesListRequest groupChannelMemberFavoritesListRequest = new GroupChannelMemberFavoritesListRequest(); // GroupChannelMemberFavoritesListRequest | 
    try {
      GroupChannelMemberFavoritesListResponse result = apiInstance.listGroupChannelMemberFavorites(groupChannelMemberFavoritesListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#listGroupChannelMemberFavorites");
      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
groupChannelMemberFavoritesListRequest	GroupChannelMemberFavoritesListRequest

Return type

GroupChannelMemberFavoritesListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

listGroupChannelMembers

GroupChannelMemberListResponse listGroupChannelMembers(groupChannelMemberListRequest)

Query group members

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelMemberListRequest groupChannelMemberListRequest = new GroupChannelMemberListRequest(); // GroupChannelMemberListRequest | 
    try {
      GroupChannelMemberListResponse result = apiInstance.listGroupChannelMembers(groupChannelMemberListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#listGroupChannelMembers");
      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
groupChannelMemberListRequest	GroupChannelMemberListRequest

Return type

GroupChannelMemberListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

listGroupChannels

GroupChannelListResponse listGroupChannels(groupChannelListRequest)

List group channels

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelListRequest groupChannelListRequest = new GroupChannelListRequest(); // GroupChannelListRequest | 
    try {
      GroupChannelListResponse result = apiInstance.listGroupChannels(groupChannelListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#listGroupChannels");
      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
groupChannelListRequest	GroupChannelListRequest

Return type

GroupChannelListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

listUserJoinedGroupChannels

GroupChannelJoinedListResponse listUserJoinedGroupChannels(groupChannelJoinedListRequest)

Query user's groups

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

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

    GroupChannelManagementApi apiInstance = new GroupChannelManagementApi(defaultClient);
    
    GroupChannelJoinedListRequest groupChannelJoinedListRequest = new GroupChannelJoinedListRequest(); // GroupChannelJoinedListRequest | 
    try {
      GroupChannelJoinedListResponse result = apiInstance.listUserJoinedGroupChannels(groupChannelJoinedListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling GroupChannelManagementApi#listUserJoinedGroupChannels");
      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
groupChannelJoinedListRequest	GroupChannelJoinedListRequest

Return type

GroupChannelJoinedListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

quitGroupChannel

CodeOnlyResponse quitGroupChannel(groupChannelQuitRequest)

Leave 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.GroupChannelManagementApi;

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

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

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	-

removeGroupChannelAdmins

CodeOnlyResponse removeGroupChannelAdmins(groupChannelAdminUsersRequest)

Remove group admins

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

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

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

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	-

removeGroupChannelMemberFavorites

CodeOnlyResponse removeGroupChannelMemberFavorites(groupChannelMemberFavoritesUpdateRequest)

Remove favorite group members

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

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

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

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	-

setGroupChannelAlias

CodeOnlyResponse setGroupChannelAlias(groupChannelAliasSetRequest)

Set group alias

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

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

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

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	-

setGroupChannelMember

CodeOnlyResponse setGroupChannelMember(groupChannelMemberSetRequest)

Set group member profile

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

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

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

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	-

transferGroupChannelOwner

CodeOnlyResponse transferGroupChannelOwner(groupChannelTransferOwnerRequest)

Transfer group ownership

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

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

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

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	-

updateGroupChannelProfile

CodeOnlyResponse updateGroupChannelProfile(groupChannelProfileUpdateRequest)

Update group info

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

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

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

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	-

FilesExpand file tree

GroupChannelManagementApi.md

Latest commit

History

GroupChannelManagementApi.md

File metadata and controls

GroupChannelManagementApi

addGroupChannelAdmins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addGroupChannelMemberFavorites

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchGetGroupChannelMembers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

batchGetGroupChannelProfiles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createGroupChannel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteGroupChannelAlias

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

dismissGroupChannel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGroupChannelAlias

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

joinGroupChannel

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

kickUserFromAllGroupChannels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listGroupChannelMemberFavorites

Example

Parameters