GroupChannelModerationApi

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

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

addGroupChannelAllowedSenderList

CodeOnlyResponse addGroupChannelAllowedSenderList(groupChannelAllowedSenderListUpdateRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelAllowedSenderListUpdateRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelAllowedSenderListUpdateRequest: GroupChannelAllowedSenderListUpdateRequest; //

const { status, data } = await apiInstance.addGroupChannelAllowedSenderList(
    groupChannelAllowedSenderListUpdateRequest
);

Parameters

Name	Type	Description	Notes
groupChannelAllowedSenderListUpdateRequest	GroupChannelAllowedSenderListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addGroupChannelFreezeList

CodeOnlyResponse addGroupChannelFreezeList(groupChannelFreezeListUpdateRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelFreezeListUpdateRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelFreezeListUpdateRequest: GroupChannelFreezeListUpdateRequest; //

const { status, data } = await apiInstance.addGroupChannelFreezeList(
    groupChannelFreezeListUpdateRequest
);

Parameters

Name	Type	Description	Notes
groupChannelFreezeListUpdateRequest	GroupChannelFreezeListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addGroupChannelUserMuteList

CodeOnlyResponse addGroupChannelUserMuteList(groupChannelUserMuteListAddRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelUserMuteListAddRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelUserMuteListAddRequest: GroupChannelUserMuteListAddRequest; //

const { status, data } = await apiInstance.addGroupChannelUserMuteList(
    groupChannelUserMuteListAddRequest
);

Parameters

Name	Type	Description	Notes
groupChannelUserMuteListAddRequest	GroupChannelUserMuteListAddRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupChannelAllowedSenderList

GroupChannelAllowedSenderListGetResponse getGroupChannelAllowedSenderList(groupChannelAllowedSenderListGetRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelAllowedSenderListGetRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelAllowedSenderListGetRequest: GroupChannelAllowedSenderListGetRequest; //

const { status, data } = await apiInstance.getGroupChannelAllowedSenderList(
    groupChannelAllowedSenderListGetRequest
);

Parameters

Name	Type	Description	Notes
groupChannelAllowedSenderListGetRequest	GroupChannelAllowedSenderListGetRequest

Return type

GroupChannelAllowedSenderListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupChannelFreezeList

GroupChannelFreezeListGetResponse getGroupChannelFreezeList(groupChannelFreezeListGetRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelFreezeListGetRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelFreezeListGetRequest: GroupChannelFreezeListGetRequest; //

const { status, data } = await apiInstance.getGroupChannelFreezeList(
    groupChannelFreezeListGetRequest
);

Parameters

Name	Type	Description	Notes
groupChannelFreezeListGetRequest	GroupChannelFreezeListGetRequest

Return type

GroupChannelFreezeListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getGroupChannelUserMuteList

GroupChannelUserMuteListGetResponse getGroupChannelUserMuteList(groupChannelUserMuteListGetRequest)

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

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelUserMuteListGetRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelUserMuteListGetRequest: GroupChannelUserMuteListGetRequest; //

const { status, data } = await apiInstance.getGroupChannelUserMuteList(
    groupChannelUserMuteListGetRequest
);

Parameters

Name	Type	Description	Notes
groupChannelUserMuteListGetRequest	GroupChannelUserMuteListGetRequest

Return type

GroupChannelUserMuteListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeGroupChannelAllowedSenderList

CodeOnlyResponse removeGroupChannelAllowedSenderList(groupChannelAllowedSenderListUpdateRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelAllowedSenderListUpdateRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelAllowedSenderListUpdateRequest: GroupChannelAllowedSenderListUpdateRequest; //

const { status, data } = await apiInstance.removeGroupChannelAllowedSenderList(
    groupChannelAllowedSenderListUpdateRequest
);

Parameters

Name	Type	Description	Notes
groupChannelAllowedSenderListUpdateRequest	GroupChannelAllowedSenderListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeGroupChannelFreezeList

CodeOnlyResponse removeGroupChannelFreezeList(groupChannelFreezeListUpdateRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelFreezeListUpdateRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelFreezeListUpdateRequest: GroupChannelFreezeListUpdateRequest; //

const { status, data } = await apiInstance.removeGroupChannelFreezeList(
    groupChannelFreezeListUpdateRequest
);

Parameters

Name	Type	Description	Notes
groupChannelFreezeListUpdateRequest	GroupChannelFreezeListUpdateRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeGroupChannelUserMuteList

CodeOnlyResponse removeGroupChannelUserMuteList(groupChannelUserMuteListRemoveRequest)

Rate limit: 100/sec.

Example

import {
    GroupChannelModerationApi,
    Configuration,
    GroupChannelUserMuteListRemoveRequest
} 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 GroupChannelModerationApi(configuration);

let groupChannelUserMuteListRemoveRequest: GroupChannelUserMuteListRemoveRequest; //

const { status, data } = await apiInstance.removeGroupChannelUserMuteList(
    groupChannelUserMuteListRemoveRequest
);

Parameters

Name	Type	Description	Notes
groupChannelUserMuteListRemoveRequest	GroupChannelUserMuteListRemoveRequest

Return type

CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

GroupChannelModerationApi.md

Latest commit

History

GroupChannelModerationApi.md

File metadata and controls

GroupChannelModerationApi

addGroupChannelAllowedSenderList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addGroupChannelFreezeList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

addGroupChannelUserMuteList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGroupChannelAllowedSenderList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGroupChannelFreezeList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getGroupChannelUserMuteList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

removeGroupChannelAllowedSenderList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

removeGroupChannelFreezeList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

removeGroupChannelUserMuteList

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details