Skip to content

Latest commit

 

History

History
1536 lines (1164 loc) · 56.1 KB

MessageManagementApi.md

File metadata and controls

1536 lines (1164 loc) · 56.1 KB

MessageManagementApi

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

Method HTTP request Description
broadcastOpenChannelMessage POST /v4/open-channel/message/broadcast Broadcast to all open channels
deleteChannelMessageHistory POST /v4/channel/message/history/delete Delete server-side channel message history
deleteChannelTypeMessageMetadata POST /v4/channel-type/message/metadata/delete Delete message metadata
deleteCommunityChannelMessageMetadata POST /v4/community-channel/message/metadata/delete Delete community-channel message metadata keys
deleteMessage POST /v4/message/delete Delete a message (recall)
listChannelTypeMessageMetadata POST /v4/channel-type/message/metadata/list Get message metadata
listCommunityChannelHistoryMessages POST /v4/community-channel/history-message/list List community-channel history messages
listCommunityChannelMessageMetadata POST /v4/community-channel/message/metadata/list List community-channel message metadata
listDirectChannelHistoryMessages POST /v4/direct-channel/history-message/list List direct-channel history messages
listGroupChannelHistoryMessages POST /v4/group-channel/history-message/list List group-channel history messages
listOpenChannelHistoryMessages POST /v4/open-channel/history-message/list List open-channel history messages
sendCommunityChannelMessage POST /v4/community-channel/message/send Send a community channel message
sendDirectChannelMessage POST /v4/direct-channel/message/send Send a direct message
sendDirectChannelStreamMessage POST /v4/direct-channel/message/stream/send Send a direct channel stream message
sendGroupChannelMessage POST /v4/group-channel/message/send Send a group message
sendGroupChannelStreamMessage POST /v4/group-channel/message/stream/send Send a group channel stream message
sendOpenChannelMessage POST /v4/open-channel/message/send Send an open channel message
setChannelTypeMessageMetadata POST /v4/channel-type/message/metadata/set Set message metadata
setCommunityChannelMessageMetadata POST /v4/community-channel/message/metadata/set Set community-channel message metadata
updateCommunityChannelMessage POST /v4/community-channel/message/update Update community-channel message
updateDirectChannelMessage POST /v4/direct-channel/message/update Update direct-channel message
updateGroupChannelMessage POST /v4/group-channel/message/update Update group-channel message

broadcastOpenChannelMessage

CodeOnlyResponse broadcastOpenChannelMessage(openChannelBroadcastRequest)

Broadcast to all open channels

Rate limit: 1/sec.

Example

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

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

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

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 -

deleteChannelMessageHistory

CodeOnlyResponse deleteChannelMessageHistory(channelMessageHistoryDeleteRequest)

Delete server-side channel message history

Rate limit: 100/sec. Server path `/v4/channel/message/history/delete` (`HistoryCleanInput`).

Example

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

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

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

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 -

deleteChannelTypeMessageMetadata

CodeOnlyResponse deleteChannelTypeMessageMetadata(channelTypeMessageMetadataDeleteRequest)

Delete message metadata

Rate limit: 100/sec (max 20 for group messages).

Example

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

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

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

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 -

deleteCommunityChannelMessageMetadata

CodeOnlyResponse deleteCommunityChannelMessageMetadata(communityChannelMessageMetadataDeleteRequest)

Delete community-channel message metadata keys

Example

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

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

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

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 -

deleteMessage

CodeOnlyResponse deleteMessage(messageDeleteRequest)

Delete a message (recall)

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

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

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

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 -

listChannelTypeMessageMetadata

ChannelTypeMessageMetadataListResponse listChannelTypeMessageMetadata(channelTypeMessageMetadataListRequest)

Get message metadata

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    ChannelTypeMessageMetadataListRequest channelTypeMessageMetadataListRequest = new ChannelTypeMessageMetadataListRequest(); // ChannelTypeMessageMetadataListRequest | 
    try {
      ChannelTypeMessageMetadataListResponse result = apiInstance.listChannelTypeMessageMetadata(channelTypeMessageMetadataListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listChannelTypeMessageMetadata");
      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
channelTypeMessageMetadataListRequest ChannelTypeMessageMetadataListRequest

Return type

ChannelTypeMessageMetadataListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listCommunityChannelHistoryMessages

MessageHistoryResponse listCommunityChannelHistoryMessages(communityChannelHistoryMessageListRequest)

List community-channel history messages

Rate limit: 10/sec. Query range is at most 14 days; messages are returned in descending timestamp order.

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    CommunityChannelHistoryMessageListRequest communityChannelHistoryMessageListRequest = new CommunityChannelHistoryMessageListRequest(); // CommunityChannelHistoryMessageListRequest | 
    try {
      MessageHistoryResponse result = apiInstance.listCommunityChannelHistoryMessages(communityChannelHistoryMessageListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listCommunityChannelHistoryMessages");
      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
communityChannelHistoryMessageListRequest CommunityChannelHistoryMessageListRequest

Return type

MessageHistoryResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listCommunityChannelMessageMetadata

CommunityChannelMessageMetadataListResponse listCommunityChannelMessageMetadata(communityChannelMessageMetadataListRequest)

List community-channel message metadata

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    CommunityChannelMessageMetadataListRequest communityChannelMessageMetadataListRequest = new CommunityChannelMessageMetadataListRequest(); // CommunityChannelMessageMetadataListRequest | 
    try {
      CommunityChannelMessageMetadataListResponse result = apiInstance.listCommunityChannelMessageMetadata(communityChannelMessageMetadataListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listCommunityChannelMessageMetadata");
      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
communityChannelMessageMetadataListRequest CommunityChannelMessageMetadataListRequest

Return type

CommunityChannelMessageMetadataListResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listDirectChannelHistoryMessages

DirectGroupHistoryMessageResponse listDirectChannelHistoryMessages(directChannelHistoryMessageListRequest)

List direct-channel history messages

Rate limit: 10/sec. Query range is at most 14 days; messages are returned in descending timestamp order.

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    DirectChannelHistoryMessageListRequest directChannelHistoryMessageListRequest = new DirectChannelHistoryMessageListRequest(); // DirectChannelHistoryMessageListRequest | 
    try {
      DirectGroupHistoryMessageResponse result = apiInstance.listDirectChannelHistoryMessages(directChannelHistoryMessageListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listDirectChannelHistoryMessages");
      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
directChannelHistoryMessageListRequest DirectChannelHistoryMessageListRequest

Return type

DirectGroupHistoryMessageResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listGroupChannelHistoryMessages

DirectGroupHistoryMessageResponse listGroupChannelHistoryMessages(groupChannelHistoryMessageListRequest)

List group-channel history messages

Rate limit: 10/sec. Query range is at most 14 days; messages are returned in descending timestamp order.

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    GroupChannelHistoryMessageListRequest groupChannelHistoryMessageListRequest = new GroupChannelHistoryMessageListRequest(); // GroupChannelHistoryMessageListRequest | 
    try {
      DirectGroupHistoryMessageResponse result = apiInstance.listGroupChannelHistoryMessages(groupChannelHistoryMessageListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listGroupChannelHistoryMessages");
      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
groupChannelHistoryMessageListRequest GroupChannelHistoryMessageListRequest

Return type

DirectGroupHistoryMessageResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

listOpenChannelHistoryMessages

OpenChannelHistoryMessageResponse listOpenChannelHistoryMessages(openChannelHistoryMessageListRequest)

List open-channel history messages

Rate limit: 10/sec. Query range is at most 14 days; messages are returned in descending timestamp order.

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    OpenChannelHistoryMessageListRequest openChannelHistoryMessageListRequest = new OpenChannelHistoryMessageListRequest(); // OpenChannelHistoryMessageListRequest | 
    try {
      OpenChannelHistoryMessageResponse result = apiInstance.listOpenChannelHistoryMessages(openChannelHistoryMessageListRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#listOpenChannelHistoryMessages");
      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
openChannelHistoryMessageListRequest OpenChannelHistoryMessageListRequest

Return type

OpenChannelHistoryMessageResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendCommunityChannelMessage

ChannelMessageSendResponse sendCommunityChannelMessage(communityChannelMessageSendRequest)

Send a community channel message

Rate limit: 100/sec (by target group count); 20/sec per channel.

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    CommunityChannelMessageSendRequest communityChannelMessageSendRequest = new CommunityChannelMessageSendRequest(); // CommunityChannelMessageSendRequest | 
    try {
      ChannelMessageSendResponse result = apiInstance.sendCommunityChannelMessage(communityChannelMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendCommunityChannelMessage");
      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
communityChannelMessageSendRequest CommunityChannelMessageSendRequest

Return type

ChannelMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendDirectChannelMessage

UserMessageSendResponse sendDirectChannelMessage(directChannelMessageSendRequest)

Send a direct message

Rate limit: 6,000 msgs/min (by recipient count).

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    DirectChannelMessageSendRequest directChannelMessageSendRequest = new DirectChannelMessageSendRequest(); // DirectChannelMessageSendRequest | 
    try {
      UserMessageSendResponse result = apiInstance.sendDirectChannelMessage(directChannelMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendDirectChannelMessage");
      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
directChannelMessageSendRequest DirectChannelMessageSendRequest

Return type

UserMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendDirectChannelStreamMessage

StreamMessageSendResponse sendDirectChannelStreamMessage(directChannelStreamMessageSendRequest)

Send a direct channel stream message

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    DirectChannelStreamMessageSendRequest directChannelStreamMessageSendRequest = new DirectChannelStreamMessageSendRequest(); // DirectChannelStreamMessageSendRequest | 
    try {
      StreamMessageSendResponse result = apiInstance.sendDirectChannelStreamMessage(directChannelStreamMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendDirectChannelStreamMessage");
      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
directChannelStreamMessageSendRequest DirectChannelStreamMessageSendRequest

Return type

StreamMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendGroupChannelMessage

ChannelMessageSendResponse sendGroupChannelMessage(groupChannelMessageSendRequest)

Send a group message

Rate limit: 20/sec (by target group count).

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    GroupChannelMessageSendRequest groupChannelMessageSendRequest = new GroupChannelMessageSendRequest(); // GroupChannelMessageSendRequest | 
    try {
      ChannelMessageSendResponse result = apiInstance.sendGroupChannelMessage(groupChannelMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendGroupChannelMessage");
      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
groupChannelMessageSendRequest GroupChannelMessageSendRequest

Return type

ChannelMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendGroupChannelStreamMessage

StreamMessageSendResponse sendGroupChannelStreamMessage(groupChannelStreamMessageSendRequest)

Send a group channel stream message

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    GroupChannelStreamMessageSendRequest groupChannelStreamMessageSendRequest = new GroupChannelStreamMessageSendRequest(); // GroupChannelStreamMessageSendRequest | 
    try {
      StreamMessageSendResponse result = apiInstance.sendGroupChannelStreamMessage(groupChannelStreamMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendGroupChannelStreamMessage");
      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
groupChannelStreamMessageSendRequest GroupChannelStreamMessageSendRequest

Return type

StreamMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

sendOpenChannelMessage

ChannelMessageSendResponse sendOpenChannelMessage(openChannelMessageSendRequest)

Send an open channel message

Rate limit: 100/sec (by target open channel count).

Example

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

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

    MessageManagementApi apiInstance = new MessageManagementApi(defaultClient);
    
    OpenChannelMessageSendRequest openChannelMessageSendRequest = new OpenChannelMessageSendRequest(); // OpenChannelMessageSendRequest | 
    try {
      ChannelMessageSendResponse result = apiInstance.sendOpenChannelMessage(openChannelMessageSendRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling MessageManagementApi#sendOpenChannelMessage");
      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
openChannelMessageSendRequest OpenChannelMessageSendRequest

Return type

ChannelMessageSendResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -

setChannelTypeMessageMetadata

CodeOnlyResponse setChannelTypeMessageMetadata(messageMetadataSetRequest)

Set message metadata

Rate limit: 100/sec (max 20 for group messages).

Example

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

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

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

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 -

setCommunityChannelMessageMetadata

CodeOnlyResponse setCommunityChannelMessageMetadata(communityChannelMessageMetadataSetRequest)

Set community-channel message metadata

Example

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

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

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

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 -

updateCommunityChannelMessage

CodeOnlyResponse updateCommunityChannelMessage(communityChannelMessageUpdateRequest)

Update community-channel message

Example

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

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

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

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 -

updateDirectChannelMessage

CodeOnlyResponse updateDirectChannelMessage(directChannelMessageUpdateRequest)

Update direct-channel message

Example

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

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

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

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 -

updateGroupChannelMessage

CodeOnlyResponse updateGroupChannelMessage(groupChannelMessageUpdateRequest)

Update group-channel message

Example

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

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

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

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 -