NexConnServerSdkPhp\CommunityChannelModerationApi

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

Method	HTTP request	Description
addCommunityChannelAllowedSenderList()	POST /v4/community-channel/allowed-sender-list/add	Add community channel allowed sender list
addCommunityChannelMutedUsers()	POST /v4/community-channel/mute-list/add	Add community-channel muted users
getCommunityChannelFreezeList()	POST /v4/community-channel/freeze-list/get	Get community channel freeze status
listCommunityChannelAllowedSenderList()	POST /v4/community-channel/allowed-sender-list/get	List community channel allowed sender list
listCommunityChannelMutedUsers()	POST /v4/community-channel/mute-list/get	List community-channel muted users
removeCommunityChannelAllowedSenderList()	POST /v4/community-channel/allowed-sender-list/remove	Remove community channel allowed sender list
removeCommunityChannelMutedUsers()	POST /v4/community-channel/mute-list/remove	Remove community-channel muted users
setCommunityChannelFreezeList()	POST /v4/community-channel/freeze-list/set	Set community channel freeze list

`addCommunityChannelAllowedSenderList()`

addCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_update_request): \NexConnServerSdkPhp\Model\CodeOnlyResponse

Add community channel allowed sender list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_allowed_sender_list_update_request = new \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest

try {
    $result = $apiInstance->addCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->addCommunityChannelAllowedSenderList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_allowed_sender_list_update_request	\NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest

Return type

\NexConnServerSdkPhp\Model\CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`addCommunityChannelMutedUsers()`

addCommunityChannelMutedUsers($community_channel_mute_list_add_request): \NexConnServerSdkPhp\Model\CodeOnlyResponse

Add community-channel muted users

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_mute_list_add_request = new \NexConnServerSdkPhp\Model\CommunityChannelMuteListAddRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelMuteListAddRequest

try {
    $result = $apiInstance->addCommunityChannelMutedUsers($community_channel_mute_list_add_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->addCommunityChannelMutedUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_mute_list_add_request	\NexConnServerSdkPhp\Model\CommunityChannelMuteListAddRequest

Return type

\NexConnServerSdkPhp\Model\CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`getCommunityChannelFreezeList()`

getCommunityChannelFreezeList($community_channel_freeze_list_get_request): \NexConnServerSdkPhp\Model\CommunityChannelFreezeListGetResponse

Get community channel freeze status

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_freeze_list_get_request = new \NexConnServerSdkPhp\Model\CommunityChannelFreezeListGetRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelFreezeListGetRequest

try {
    $result = $apiInstance->getCommunityChannelFreezeList($community_channel_freeze_list_get_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->getCommunityChannelFreezeList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_freeze_list_get_request	\NexConnServerSdkPhp\Model\CommunityChannelFreezeListGetRequest

Return type

\NexConnServerSdkPhp\Model\CommunityChannelFreezeListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`listCommunityChannelAllowedSenderList()`

listCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_get_request): \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListGetResponse

List community channel allowed sender list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_allowed_sender_list_get_request = new \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListGetRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListGetRequest

try {
    $result = $apiInstance->listCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_get_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->listCommunityChannelAllowedSenderList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_allowed_sender_list_get_request	\NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListGetRequest

Return type

\NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`listCommunityChannelMutedUsers()`

listCommunityChannelMutedUsers($community_channel_mute_list_get_request): \NexConnServerSdkPhp\Model\CommunityChannelMuteListGetResponse

List community-channel muted users

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_mute_list_get_request = new \NexConnServerSdkPhp\Model\CommunityChannelMuteListGetRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelMuteListGetRequest

try {
    $result = $apiInstance->listCommunityChannelMutedUsers($community_channel_mute_list_get_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->listCommunityChannelMutedUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_mute_list_get_request	\NexConnServerSdkPhp\Model\CommunityChannelMuteListGetRequest

Return type

\NexConnServerSdkPhp\Model\CommunityChannelMuteListGetResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`removeCommunityChannelAllowedSenderList()`

removeCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_update_request): \NexConnServerSdkPhp\Model\CodeOnlyResponse

Remove community channel allowed sender list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_allowed_sender_list_update_request = new \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest

try {
    $result = $apiInstance->removeCommunityChannelAllowedSenderList($community_channel_allowed_sender_list_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->removeCommunityChannelAllowedSenderList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_allowed_sender_list_update_request	\NexConnServerSdkPhp\Model\CommunityChannelAllowedSenderListUpdateRequest

Return type

\NexConnServerSdkPhp\Model\CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`removeCommunityChannelMutedUsers()`

removeCommunityChannelMutedUsers($community_channel_mute_list_remove_request): \NexConnServerSdkPhp\Model\CodeOnlyResponse

Remove community-channel muted users

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_mute_list_remove_request = new \NexConnServerSdkPhp\Model\CommunityChannelMuteListRemoveRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelMuteListRemoveRequest

try {
    $result = $apiInstance->removeCommunityChannelMutedUsers($community_channel_mute_list_remove_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->removeCommunityChannelMutedUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_mute_list_remove_request	\NexConnServerSdkPhp\Model\CommunityChannelMuteListRemoveRequest

Return type

\NexConnServerSdkPhp\Model\CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

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

`setCommunityChannelFreezeList()`

setCommunityChannelFreezeList($community_channel_freeze_list_set_request): \NexConnServerSdkPhp\Model\CodeOnlyResponse

Set community channel freeze list

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: NexconnSignature
$config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKey('App-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = NexConnServerSdkPhp\Configuration::getDefaultConfiguration()->setApiKeyPrefix('App-Key', 'Bearer');


$apiInstance = new NexConnServerSdkPhp\Api\CommunityChannelModerationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$community_channel_freeze_list_set_request = new \NexConnServerSdkPhp\Model\CommunityChannelFreezeListSetRequest(); // \NexConnServerSdkPhp\Model\CommunityChannelFreezeListSetRequest

try {
    $result = $apiInstance->setCommunityChannelFreezeList($community_channel_freeze_list_set_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommunityChannelModerationApi->setCommunityChannelFreezeList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
community_channel_freeze_list_set_request	\NexConnServerSdkPhp\Model\CommunityChannelFreezeListSetRequest

Return type

\NexConnServerSdkPhp\Model\CodeOnlyResponse

Authorization

NexconnSignature

HTTP request headers

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

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

FilesExpand file tree

CommunityChannelModerationApi.md

Latest commit

History

CommunityChannelModerationApi.md

File metadata and controls

NexConnServerSdkPhp\CommunityChannelModerationApi

addCommunityChannelAllowedSenderList()

Example

Parameters

Return type

Authorization

HTTP request headers

addCommunityChannelMutedUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

getCommunityChannelFreezeList()

Example

Parameters

Return type

Authorization

HTTP request headers

listCommunityChannelAllowedSenderList()

Example

Parameters

Return type

Authorization

HTTP request headers

listCommunityChannelMutedUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

removeCommunityChannelAllowedSenderList()

Example

Parameters

Return type

Authorization

HTTP request headers

removeCommunityChannelMutedUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

setCommunityChannelFreezeList()

Example

Parameters

Return type

Authorization

HTTP request headers

`addCommunityChannelAllowedSenderList()`

`addCommunityChannelMutedUsers()`

`getCommunityChannelFreezeList()`

`listCommunityChannelAllowedSenderList()`

`listCommunityChannelMutedUsers()`

`removeCommunityChannelAllowedSenderList()`

`removeCommunityChannelMutedUsers()`

`setCommunityChannelFreezeList()`