OpenAPI\Client\ConversationsApi

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

Method	HTTP request	Description
chatbotChatbotIDConversationsConversationIDDelete	DELETE /chatbot/{chatbotID}/conversations/{conversationID}	Delete a specific Conversations
chatbotChatbotIDConversationsConversationIDGet	GET /chatbot/{chatbotID}/conversations/{conversationID}	Get a specific Conversations
chatbotChatbotIDConversationsConversationIDPut	PUT /chatbot/{chatbotID}/conversations/{conversationID}	Returns a specific Conversations
chatbotChatbotIDConversationsDelete	DELETE /chatbot/{chatbotID}/conversations	Delete a all Conversations
chatbotChatbotIDConversationsGet	GET /chatbot/{chatbotID}/conversations	Returns all Conversations
chatbotChatbotIDConversationsPost	POST /chatbot/{chatbotID}/conversations	Create a specific Conversations
chatbotChatbotIDTurnsTurnIdPut	PUT /chatbot/{chatbotID}/turns/{turnId}	Modifies a turn

chatbotChatbotIDConversationsConversationIDDelete

chatbotChatbotIDConversationsConversationIDDelete($chatbot_id, $conversation_id)

Delete a specific Conversations

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\ConversationsApi(
    // 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.
$conversation_id = 'conversation_id_example'; // string | Pass in a conversationID to identify the Conversations.

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

Parameters

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

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]

chatbotChatbotIDConversationsConversationIDGet

\OpenAPI\Client\Model\Conversation chatbotChatbotIDConversationsConversationIDGet($chatbot_id, $conversation_id)

Get a specific Conversations

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\ConversationsApi(
    // 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.
$conversation_id = 'conversation_id_example'; // string | Pass in a conversationID to identify the Conversations.

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

Parameters

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

Return type

\OpenAPI\Client\Model\Conversation

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]

chatbotChatbotIDConversationsConversationIDPut

\OpenAPI\Client\Model\Conversation chatbotChatbotIDConversationsConversationIDPut($chatbot_id, $conversation_id, $conversation)

Returns a specific Conversations

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\ConversationsApi(
    // 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.
$conversation_id = 'conversation_id_example'; // string | Pass in a conversationID to identify the Conversations.
$conversation = new \OpenAPI\Client\Model\Conversation(); // \OpenAPI\Client\Model\Conversation | 

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

Parameters

Name	Type	Description
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
conversation_id	string	Pass in a conversationID to identify the Conversations.
conversation	\OpenAPI\Client\Model\Conversation

Return type

\OpenAPI\Client\Model\Conversation

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]

chatbotChatbotIDConversationsDelete

chatbotChatbotIDConversationsDelete($chatbot_id)

Delete a all Conversations

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\ConversationsApi(
    // 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->chatbotChatbotIDConversationsDelete($chatbot_id);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->chatbotChatbotIDConversationsDelete: ', $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]

chatbotChatbotIDConversationsGet

\OpenAPI\Client\Model\Conversation[] chatbotChatbotIDConversationsGet($chatbot_id)

Returns all Conversations

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\ConversationsApi(
    // 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->chatbotChatbotIDConversationsGet($chatbot_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->chatbotChatbotIDConversationsGet: ', $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\Conversation[]

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]

chatbotChatbotIDConversationsPost

\OpenAPI\Client\Model\Conversation chatbotChatbotIDConversationsPost($chatbot_id, $conversation)

Create a specific Conversations

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\ConversationsApi(
    // 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.
$conversation = new \OpenAPI\Client\Model\Conversation(); // \OpenAPI\Client\Model\Conversation | 

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

Parameters

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

Return type

\OpenAPI\Client\Model\Conversation

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]

chatbotChatbotIDTurnsTurnIdPut

\OpenAPI\Client\Model\Conversation chatbotChatbotIDTurnsTurnIdPut($chatbot_id, $turn_id, $conversation_turn)

Modifies a turn

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\ConversationsApi(
    // 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.
$turn_id = 'turn_id_example'; // string | Pass in a turnId to identify the turn.
$conversation_turn = new \OpenAPI\Client\Model\ConversationTurn(); // \OpenAPI\Client\Model\ConversationTurn | 

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

Parameters

Name	Type	Description
chatbot_id	string	Pass in a chatbotID to identify the chatbot.
turn_id	string	Pass in a turnId to identify the turn.
conversation_turn	\OpenAPI\Client\Model\ConversationTurn

Return type

\OpenAPI\Client\Model\Conversation

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

ConversationsApi.md

Latest commit

History

ConversationsApi.md

File metadata and controls

OpenAPI\Client\ConversationsApi

chatbotChatbotIDConversationsConversationIDDelete

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDConversationsConversationIDGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDConversationsConversationIDPut

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDConversationsDelete

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDConversationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDConversationsPost

Example

Parameters

Return type

Authorization

HTTP request headers

chatbotChatbotIDTurnsTurnIdPut

Example

Parameters

Return type

Authorization

HTTP request headers