OpenAPI\Client\ChatbotApi

All URIs are relative to https://chatbots.obilytics.com/api

Method	HTTP request	Description
chatbotChatbotIDDelete	DELETE /chatbot/{chatbotID}	Delete a chatbots
chatbotChatbotIDDeployPost	POST /chatbot/{chatbotID}/deploy	Deploys a chatbot
chatbotChatbotIDExportGet	GET /chatbot/{chatbotID}/export	Creates an export of the chatbot including all the examples, expressions and regex
chatbotChatbotIDGet	GET /chatbot/{chatbotID}	Returns a specific Chatbot
chatbotChatbotIDPut	PUT /chatbot/{chatbotID}	Modiefies an existing chatbot
chatbotGet	GET /chatbot	Returns all Chatbots
chatbotImportPost	POST /chatbot/import	Create a complete chatbot from a dictionary
chatbotPost	POST /chatbot	Create an empty chatbot

chatbotChatbotIDDelete

chatbotChatbotIDDelete($chatbot_id)

Delete a chatbots

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $apiInstance->chatbotChatbotIDDelete($chatbot_id);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotChatbotIDDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

chatbotChatbotIDDeployPost

\OpenAPI\Client\Model\Chatbot chatbotChatbotIDDeployPost($chatbot_id)

Deploys a chatbot

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDDeployPost($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotChatbotIDDeployPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

\OpenAPI\Client\Model\Chatbot

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

chatbotChatbotIDExportGet

\OpenAPI\Client\Model\CompleteChatbot chatbotChatbotIDExportGet($chatbot_id)

Creates an export of the chatbot including all the examples, expressions and regex

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDExportGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotChatbotIDExportGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

\OpenAPI\Client\Model\CompleteChatbot

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

chatbotChatbotIDGet

\OpenAPI\Client\Model\Chatbot chatbotChatbotIDGet($chatbot_id)

Returns a specific Chatbot

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.

try {
    $result = $apiInstance->chatbotChatbotIDGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotChatbotIDGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.

Return type

\OpenAPI\Client\Model\Chatbot

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

chatbotChatbotIDPut

\OpenAPI\Client\Model\Chatbot chatbotChatbotIDPut($chatbot_id, $update_chatbot)

Modiefies an existing chatbot

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$chatbot_id = 'chatbot_id_example'; // string | Pass in a chatbotID to identify the chatbot.
$update_chatbot = new \OpenAPI\Client\Model\UpdateChatbot(); // \OpenAPI\Client\Model\UpdateChatbot | 

try {
    $result = $apiInstance->chatbotChatbotIDPut($chatbot_id, $update_chatbot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotChatbotIDPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
update_chatbot	\OpenAPI\Client\Model\UpdateChatbot

Return type

\OpenAPI\Client\Model\Chatbot

Authorization

bearerAuth

HTTP request headers

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

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

chatbotGet

\OpenAPI\Client\Model\Chatbot[] chatbotGet()

Returns all Chatbots

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\Chatbot[]

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

chatbotImportPost

\OpenAPI\Client\Model\CompleteChatbot[] chatbotImportPost($complete_chatbot)

Create a complete chatbot from a dictionary

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$complete_chatbot = new \OpenAPI\Client\Model\CompleteChatbot(); // \OpenAPI\Client\Model\CompleteChatbot | 

try {
    $result = $apiInstance->chatbotImportPost($complete_chatbot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotImportPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
complete_chatbot	\OpenAPI\Client\Model\CompleteChatbot

Return type

\OpenAPI\Client\Model\CompleteChatbot[]

Authorization

bearerAuth

HTTP request headers

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

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

chatbotPost

\OpenAPI\Client\Model\Chatbot chatbotPost($empty_chatbot)

Create an empty chatbot

Example

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


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


$apiInstance = new OpenAPI\Client\Api\ChatbotApi(
    // 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
);
$empty_chatbot = new \OpenAPI\Client\Model\EmptyChatbot(); // \OpenAPI\Client\Model\EmptyChatbot | 

try {
    $result = $apiInstance->chatbotPost($empty_chatbot);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatbotApi->chatbotPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
empty_chatbot	\OpenAPI\Client\Model\EmptyChatbot

Return type

\OpenAPI\Client\Model\Chatbot

Authorization

bearerAuth

HTTP request headers

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

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

Files

ChatbotApi.md

Latest commit

History

ChatbotApi.md

File metadata and controls

OpenAPI\Client\ChatbotApi

chatbotChatbotIDDelete

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDDeployPost

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDExportGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDPut

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotImportPost

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotPost

Example

Parameters

Return type

Authorization

HTTP request headers