HistoryApi.md

Swagger\Client\HistoryApi

All URIs are relative to https://localhost/api/v5

Method	HTTP request	Description
getChat	GET /history/message	Get message history
getCommands	GET /history/cmd	Get command history

getChat

\Swagger\Client\Model\Message[] getChat($details, $accept, $pretty)

Get message history

View a history of the server messages. Required permissions: - history.message

Example

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

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\HistoryApi(
    // 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
);
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->getChat($details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->getChat: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\Message[]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

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

getCommands

\Swagger\Client\Model\CommandCall[] getCommands($details, $accept, $pretty)

Get command history

View a history of the server commands. Required permissions: - history.cmd

Example

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

// Configure API key authorization: ApiKeyHeader
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-WebAPI-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-WebAPI-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('key', 'Bearer');

$apiInstance = new Swagger\Client\Api\HistoryApi(
    // 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
);
$details = true; // bool | Add to include additional details, omit or false otherwise
$accept = "accept_example"; // string | Override the 'Accept' request header (useful for debugging your requests)
$pretty = true; // bool | Add to make the Web-API pretty print the response (useful for debugging your requests)

try {
    $result = $apiInstance->getCommands($details, $accept, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HistoryApi->getCommands: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
details	bool	Add to include additional details, omit or false otherwise	[optional]
accept	string	Override the 'Accept' request header (useful for debugging your requests)	[optional]
pretty	bool	Add to make the Web-API pretty print the response (useful for debugging your requests)	[optional]

Return type

\Swagger\Client\Model\CommandCall[]

Authorization

ApiKeyHeader, ApiKeyQuery

HTTP request headers

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

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