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 |
| listCommunityChannelMessageMetadata | POST /v4/community-channel/message/metadata/list | List community-channel message metadata |
| 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 |
CodeOnlyResponse broadcastOpenChannelMessage(openChannelBroadcastRequest)
Rate limit: 1/sec.
import {
MessageManagementApi,
Configuration,
OpenChannelBroadcastRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let openChannelBroadcastRequest: OpenChannelBroadcastRequest; //
const { status, data } = await apiInstance.broadcastOpenChannelMessage(
openChannelBroadcastRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| openChannelBroadcastRequest | OpenChannelBroadcastRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse deleteChannelMessageHistory(channelMessageHistoryDeleteRequest)
Rate limit: 100/sec. Server path /v4/channel/message/history/delete (HistoryCleanInput).
import {
MessageManagementApi,
Configuration,
ChannelMessageHistoryDeleteRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let channelMessageHistoryDeleteRequest: ChannelMessageHistoryDeleteRequest; //
const { status, data } = await apiInstance.deleteChannelMessageHistory(
channelMessageHistoryDeleteRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| channelMessageHistoryDeleteRequest | ChannelMessageHistoryDeleteRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse deleteChannelTypeMessageMetadata(channelTypeMessageMetadataDeleteRequest)
Rate limit: 100/sec (max 20 for group messages).
import {
MessageManagementApi,
Configuration,
ChannelTypeMessageMetadataDeleteRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let channelTypeMessageMetadataDeleteRequest: ChannelTypeMessageMetadataDeleteRequest; //
const { status, data } = await apiInstance.deleteChannelTypeMessageMetadata(
channelTypeMessageMetadataDeleteRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| channelTypeMessageMetadataDeleteRequest | ChannelTypeMessageMetadataDeleteRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse deleteCommunityChannelMessageMetadata(communityChannelMessageMetadataDeleteRequest)
import {
MessageManagementApi,
Configuration,
CommunityChannelMessageMetadataDeleteRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let communityChannelMessageMetadataDeleteRequest: CommunityChannelMessageMetadataDeleteRequest; //
const { status, data } = await apiInstance.deleteCommunityChannelMessageMetadata(
communityChannelMessageMetadataDeleteRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| communityChannelMessageMetadataDeleteRequest | CommunityChannelMessageMetadataDeleteRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse deleteMessage(messageDeleteRequest)
Rate limit: 100/sec.
import {
MessageManagementApi,
Configuration,
MessageDeleteRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let messageDeleteRequest: MessageDeleteRequest; //
const { status, data } = await apiInstance.deleteMessage(
messageDeleteRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| messageDeleteRequest | MessageDeleteRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChannelTypeMessageMetadataListResponse listChannelTypeMessageMetadata(channelTypeMessageMetadataListRequest)
Rate limit: 100/sec.
import {
MessageManagementApi,
Configuration,
ChannelTypeMessageMetadataListRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let channelTypeMessageMetadataListRequest: ChannelTypeMessageMetadataListRequest; //
const { status, data } = await apiInstance.listChannelTypeMessageMetadata(
channelTypeMessageMetadataListRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| channelTypeMessageMetadataListRequest | ChannelTypeMessageMetadataListRequest |
ChannelTypeMessageMetadataListResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CommunityChannelMessageMetadataListResponse listCommunityChannelMessageMetadata(communityChannelMessageMetadataListRequest)
import {
MessageManagementApi,
Configuration,
CommunityChannelMessageMetadataListRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let communityChannelMessageMetadataListRequest: CommunityChannelMessageMetadataListRequest; //
const { status, data } = await apiInstance.listCommunityChannelMessageMetadata(
communityChannelMessageMetadataListRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| communityChannelMessageMetadataListRequest | CommunityChannelMessageMetadataListRequest |
CommunityChannelMessageMetadataListResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChannelMessageSendResponse sendCommunityChannelMessage(communityChannelMessageSendRequest)
Rate limit: 100/sec (by target group count); 20/sec per channel.
import {
MessageManagementApi,
Configuration,
CommunityChannelMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let communityChannelMessageSendRequest: CommunityChannelMessageSendRequest; //
const { status, data } = await apiInstance.sendCommunityChannelMessage(
communityChannelMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| communityChannelMessageSendRequest | CommunityChannelMessageSendRequest |
ChannelMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserMessageSendResponse sendDirectChannelMessage(directChannelMessageSendRequest)
Rate limit: 6,000 msgs/min (by recipient count).
import {
MessageManagementApi,
Configuration,
DirectChannelMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let directChannelMessageSendRequest: DirectChannelMessageSendRequest; //
const { status, data } = await apiInstance.sendDirectChannelMessage(
directChannelMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| directChannelMessageSendRequest | DirectChannelMessageSendRequest |
UserMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StreamMessageSendResponse sendDirectChannelStreamMessage(directChannelStreamMessageSendRequest)
Rate limit: 100/sec.
import {
MessageManagementApi,
Configuration,
DirectChannelStreamMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let directChannelStreamMessageSendRequest: DirectChannelStreamMessageSendRequest; //
const { status, data } = await apiInstance.sendDirectChannelStreamMessage(
directChannelStreamMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| directChannelStreamMessageSendRequest | DirectChannelStreamMessageSendRequest |
StreamMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChannelMessageSendResponse sendGroupChannelMessage(groupChannelMessageSendRequest)
Rate limit: 20/sec (by target group count).
import {
MessageManagementApi,
Configuration,
GroupChannelMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let groupChannelMessageSendRequest: GroupChannelMessageSendRequest; //
const { status, data } = await apiInstance.sendGroupChannelMessage(
groupChannelMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| groupChannelMessageSendRequest | GroupChannelMessageSendRequest |
ChannelMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StreamMessageSendResponse sendGroupChannelStreamMessage(groupChannelStreamMessageSendRequest)
Rate limit: 100/sec.
import {
MessageManagementApi,
Configuration,
GroupChannelStreamMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let groupChannelStreamMessageSendRequest: GroupChannelStreamMessageSendRequest; //
const { status, data } = await apiInstance.sendGroupChannelStreamMessage(
groupChannelStreamMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| groupChannelStreamMessageSendRequest | GroupChannelStreamMessageSendRequest |
StreamMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ChannelMessageSendResponse sendOpenChannelMessage(openChannelMessageSendRequest)
Rate limit: 100/sec (by target open channel count).
import {
MessageManagementApi,
Configuration,
OpenChannelMessageSendRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let openChannelMessageSendRequest: OpenChannelMessageSendRequest; //
const { status, data } = await apiInstance.sendOpenChannelMessage(
openChannelMessageSendRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| openChannelMessageSendRequest | OpenChannelMessageSendRequest |
ChannelMessageSendResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse setChannelTypeMessageMetadata(messageMetadataSetRequest)
Rate limit: 100/sec (max 20 for group messages).
import {
MessageManagementApi,
Configuration,
MessageMetadataSetRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let messageMetadataSetRequest: MessageMetadataSetRequest; //
const { status, data } = await apiInstance.setChannelTypeMessageMetadata(
messageMetadataSetRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| messageMetadataSetRequest | MessageMetadataSetRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse setCommunityChannelMessageMetadata(communityChannelMessageMetadataSetRequest)
import {
MessageManagementApi,
Configuration,
CommunityChannelMessageMetadataSetRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let communityChannelMessageMetadataSetRequest: CommunityChannelMessageMetadataSetRequest; //
const { status, data } = await apiInstance.setCommunityChannelMessageMetadata(
communityChannelMessageMetadataSetRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| communityChannelMessageMetadataSetRequest | CommunityChannelMessageMetadataSetRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse updateCommunityChannelMessage(communityChannelMessageUpdateRequest)
import {
MessageManagementApi,
Configuration,
CommunityChannelMessageUpdateRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let communityChannelMessageUpdateRequest: CommunityChannelMessageUpdateRequest; //
const { status, data } = await apiInstance.updateCommunityChannelMessage(
communityChannelMessageUpdateRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| communityChannelMessageUpdateRequest | CommunityChannelMessageUpdateRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse updateDirectChannelMessage(directChannelMessageUpdateRequest)
import {
MessageManagementApi,
Configuration,
DirectChannelMessageUpdateRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let directChannelMessageUpdateRequest: DirectChannelMessageUpdateRequest; //
const { status, data } = await apiInstance.updateDirectChannelMessage(
directChannelMessageUpdateRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| directChannelMessageUpdateRequest | DirectChannelMessageUpdateRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CodeOnlyResponse updateGroupChannelMessage(groupChannelMessageUpdateRequest)
import {
MessageManagementApi,
Configuration,
GroupChannelMessageUpdateRequest
} from '@nexconn/server-sdk';
const configuration = new Configuration();
configuration.setRongCloudCredentials(
process.env.RONGCLOUD_APP_KEY!,
process.env.RONGCLOUD_APP_SECRET!,
);
configuration.setPrimaryBackupDomains(
process.env.RONGCLOUD_PRIMARY_API_DOMAIN!,
process.env.RONGCLOUD_SECONDARY_API_DOMAIN!,
);
const apiInstance = new MessageManagementApi(configuration);
let groupChannelMessageUpdateRequest: GroupChannelMessageUpdateRequest; //
const { status, data } = await apiInstance.updateGroupChannelMessage(
groupChannelMessageUpdateRequest
);| Name | Type | Description | Notes |
|---|---|---|---|
| groupChannelMessageUpdateRequest | GroupChannelMessageUpdateRequest |
CodeOnlyResponse
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]