Ageras\Api\ConversationsApi

All URIs are relative to https://api.ageras.com/v2

Method	HTTP request	Description
conversationsActionsCreate	POST /conversations/{conversation_id}/actions
conversationsAttachmentsCreate	POST /conversations/attachments
conversationsAttachmentsCreate_0	POST /conversations/{conversation_id}/attachments
conversationsAttachmentsGet	GET /conversations/attachments/{attachment_id}
conversationsAttachmentsGet_0	GET /conversations/{conversation_id}/attachments/{attachment_id}
conversationsAttachmentsIndex	GET /conversations/attachments
conversationsAttachmentsIndex_0	GET /conversations/{conversation_id}/attachments
conversationsCreate	POST /conversations
conversationsGet	GET /conversations/{conversation_id}
conversationsIndex	GET /conversations
conversationsMessagesAttachmentsCreate	POST /conversations/conversations/messages/attachments
conversationsMessagesAttachmentsCreate_0	POST /conversations/messages/attachments
conversationsMessagesAttachmentsCreate_1	POST /conversations/{conversation_id}/messages/attachments
conversationsMessagesAttachmentsGet	GET /conversations/conversations/messages/attachments/{attachment_id}
conversationsMessagesAttachmentsGet_0	GET /conversations/messages/attachments/{attachment_id}
conversationsMessagesAttachmentsGet_1	GET /conversations/{conversation_id}/messages/attachments/{attachment_id}
conversationsMessagesAttachmentsIndex	GET /conversations/conversations/messages/attachments
conversationsMessagesAttachmentsIndex_0	GET /conversations/messages/attachments
conversationsMessagesAttachmentsIndex_1	GET /conversations/{conversation_id}/messages/attachments
conversationsMessagesCreate	POST /conversations/messages
conversationsMessagesCreate_0	POST /conversations/{conversation_id}/messages
conversationsMessagesGet	GET /conversations/messages/{message_id}
conversationsMessagesGet_0	GET /conversations/{conversation_id}/messages/{message_id}
conversationsMessagesIndex	GET /conversations/messages
conversationsMessagesIndex_0	GET /conversations/{conversation_id}/messages

conversationsActionsCreate

\Ageras\Api\ConversationResource conversationsActionsCreate($conversation_id , $conversation_action_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$conversation_action_resource = new \Ageras\Api\ConversationActionResource(); // \Ageras\Api\ConversationActionResource | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
conversation_action_resource	\Ageras\Api\ConversationActionResource

Return type

\Ageras\Api\ConversationResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsCreate

\Ageras\Api\AttachmentResource conversationsAttachmentsCreate($attachment_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_resource = new \Ageras\Api\AttachmentResource(); // \Ageras\Api\AttachmentResource | 

try {
    $result = $api_instance->conversationsAttachmentsCreate($attachment_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsAttachmentsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_resource	\Ageras\Api\AttachmentResource

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsCreate_0

\Ageras\Api\AttachmentResource conversationsAttachmentsCreate_0($conversation_id , $attachment_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$attachment_resource = new \Ageras\Api\AttachmentResource(); // \Ageras\Api\AttachmentResource | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
attachment_resource	\Ageras\Api\AttachmentResource

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsGet

\Ageras\Api\AttachmentResource conversationsAttachmentsGet($attachment_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_id = "attachment_id_example"; // string | 

try {
    $result = $api_instance->conversationsAttachmentsGet($attachment_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsAttachmentsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_id	string

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsGet_0

\Ageras\Api\AttachmentResource conversationsAttachmentsGet_0($conversation_id, $attachment_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$attachment_id = "attachment_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
attachment_id	string

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsIndex

\Ageras\Api\AttachmentResult conversationsAttachmentsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$criteria = [
        'conversation_id' => "conversation_id_example"; // string | Conversation id @var int
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->conversationsAttachmentsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsAttachmentsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_id	string	Conversation id @var int	[optional]
message_id	string	Message ID. @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AttachmentResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsAttachmentsIndex_0

\Ageras\Api\AttachmentResult conversationsAttachmentsIndex_0($conversation_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$criteria = [
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

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

Parameters

Name	Type	Description	Notes
conversation_id	string
message_id	string	Message ID. @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AttachmentResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsCreate

\Ageras\Api\ConversationResource conversationsCreate($conversation_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_resource = new \Ageras\Api\ConversationResource(); // \Ageras\Api\ConversationResource | 

try {
    $result = $api_instance->conversationsCreate($conversation_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_resource	\Ageras\Api\ConversationResource

Return type

\Ageras\Api\ConversationResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsGet

\Ageras\Api\ConversationResource conversationsGet($conversation_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string

Return type

\Ageras\Api\ConversationResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsIndex

\Ageras\Api\ConversationResult conversationsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$criteria = [
        'conversation_id' => "conversation_id_example"; // string | Conversation id.
        'project_id' => "project_id_example"; // string | Project id
        'partner_id' => "partner_id_example"; // string | Partner id
        'partner_user_id' => "partner_user_id_example"; // string | Partner user id
        'client_id' => "client_id_example"; // string | Client id
        'employee_id' => "employee_id_example"; // string | Employee id
        'lead_id' => "lead_id_example"; // string | Lead id
        'sort' => "latest_activity"; // string | 
        'is_lead_validated' => false; // bool | 
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->conversationsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_id	string	Conversation id.	[optional]
project_id	string	Project id	[optional]
partner_id	string	Partner id	[optional]
partner_user_id	string	Partner user id	[optional]
client_id	string	Client id	[optional]
employee_id	string	Employee id	[optional]
lead_id	string	Lead id	[optional]
sort	string		[optional] [default to latest_activity]
is_lead_validated	bool		[optional] [default to false]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ConversationResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsCreate

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsCreate($attachment_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_resource = new \Ageras\Api\AttachmentResource(); // \Ageras\Api\AttachmentResource | 

try {
    $result = $api_instance->conversationsMessagesAttachmentsCreate($attachment_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_resource	\Ageras\Api\AttachmentResource

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsCreate_0

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsCreate_0($attachment_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_resource = new \Ageras\Api\AttachmentResource(); // \Ageras\Api\AttachmentResource | 

try {
    $result = $api_instance->conversationsMessagesAttachmentsCreate_0($attachment_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsCreate_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_resource	\Ageras\Api\AttachmentResource

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsCreate_1

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsCreate_1($conversation_id , $attachment_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$attachment_resource = new \Ageras\Api\AttachmentResource(); // \Ageras\Api\AttachmentResource | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
attachment_resource	\Ageras\Api\AttachmentResource

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsGet

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsGet($attachment_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_id = "attachment_id_example"; // string | 

try {
    $result = $api_instance->conversationsMessagesAttachmentsGet($attachment_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_id	string

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsGet_0

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsGet_0($attachment_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$attachment_id = "attachment_id_example"; // string | 

try {
    $result = $api_instance->conversationsMessagesAttachmentsGet_0($attachment_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
attachment_id	string

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsGet_1

\Ageras\Api\AttachmentResource conversationsMessagesAttachmentsGet_1($conversation_id, $attachment_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$attachment_id = "attachment_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
attachment_id	string

Return type

\Ageras\Api\AttachmentResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsIndex

\Ageras\Api\AttachmentResult conversationsMessagesAttachmentsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$criteria = [
        'conversation_id' => "conversation_id_example"; // string | Conversation id @var int
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->conversationsMessagesAttachmentsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_id	string	Conversation id @var int	[optional]
message_id	string	Message ID. @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AttachmentResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsIndex_0

\Ageras\Api\AttachmentResult conversationsMessagesAttachmentsIndex_0($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$criteria = [
        'conversation_id' => "conversation_id_example"; // string | Conversation id @var int
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->conversationsMessagesAttachmentsIndex_0($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesAttachmentsIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_id	string	Conversation id @var int	[optional]
message_id	string	Message ID. @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AttachmentResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesAttachmentsIndex_1

\Ageras\Api\AttachmentResult conversationsMessagesAttachmentsIndex_1($conversation_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$criteria = [
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

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

Parameters

Name	Type	Description	Notes
conversation_id	string
message_id	string	Message ID. @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AttachmentResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesCreate

\Ageras\Api\MessageResource conversationsMessagesCreate($message_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$message_resource = new \Ageras\Api\MessageResource(); // \Ageras\Api\MessageResource | 

try {
    $result = $api_instance->conversationsMessagesCreate($message_resource);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
message_resource	\Ageras\Api\MessageResource

Return type

\Ageras\Api\MessageResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesCreate_0

\Ageras\Api\MessageResource conversationsMessagesCreate_0($conversation_id , $message_resource)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$message_resource = new \Ageras\Api\MessageResource(); // \Ageras\Api\MessageResource | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
message_resource	\Ageras\Api\MessageResource

Return type

\Ageras\Api\MessageResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesGet

\Ageras\Api\MessageResource conversationsMessagesGet($message_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$message_id = "message_id_example"; // string | 

try {
    $result = $api_instance->conversationsMessagesGet($message_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
message_id	string

Return type

\Ageras\Api\MessageResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesGet_0

\Ageras\Api\MessageResource conversationsMessagesGet_0($conversation_id, $message_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$message_id = "message_id_example"; // string | 

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

Parameters

Name	Type	Description	Notes
conversation_id	string
message_id	string

Return type

\Ageras\Api\MessageResource

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesIndex

\Ageras\Api\MessageResult conversationsMessagesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$criteria = [
        'conversation_id' => "conversation_id_example"; // string | Conversation id @var int
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'participant_id' => 56; // int | Message Participant ID. @var int
        'unread_by_participant_id' => 56; // int | Parameter for getting unread messages by participant_id @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->conversationsMessagesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationsMessagesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
conversation_id	string	Conversation id @var int	[optional]
message_id	string	Message ID. @var int	[optional]
participant_id	int	Message Participant ID. @var int	[optional]
unread_by_participant_id	int	Parameter for getting unread messages by participant_id @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\MessageResult

Authorization

jwt, login

HTTP request headers

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

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

conversationsMessagesIndex_0

\Ageras\Api\MessageResult conversationsMessagesIndex_0($conversation_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ConversationsApi();
$conversation_id = "conversation_id_example"; // string | 
$criteria = [
        'message_id' => "message_id_example"; // string | Message ID. @var int
        'participant_id' => 56; // int | Message Participant ID. @var int
        'unread_by_participant_id' => 56; // int | Parameter for getting unread messages by participant_id @var int
        'sort' => "created_at"; // string | Sort messages
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

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

Parameters

Name	Type	Description	Notes
conversation_id	string
message_id	string	Message ID. @var int	[optional]
participant_id	int	Message Participant ID. @var int	[optional]
unread_by_participant_id	int	Parameter for getting unread messages by participant_id @var int	[optional]
sort	string	Sort messages	[optional] [default to created_at]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\MessageResult

Authorization

jwt, login

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

Ageras\Api\ConversationsApi

conversationsActionsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsCreate_0

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsGet

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsGet_0

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsIndex

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsAttachmentsIndex_0

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsGet

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsIndex

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsMessagesAttachmentsCreate

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsMessagesAttachmentsCreate_0

Example

Parameters

Return type

Authorization

HTTP request headers

conversationsMessagesAttachmentsCreate_1