OpenAPI\Client\ChatsApi

All URIs are relative to https://api.partner.market.yandex.ru, except if the operation defines another base path.

Method	HTTP request	Description
createChat()	POST /businesses/{businessId}/chats/new	Создание нового чата с покупателем
getChatHistory()	POST /businesses/{businessId}/chats/history	Получение истории сообщений в чате
getChats()	POST /businesses/{businessId}/chats	Получение доступных чатов
sendFileToChat()	POST /businesses/{businessId}/chats/file/send	Отправка файла в чат
sendMessageToChat()	POST /businesses/{businessId}/chats/message	Отправка сообщения в чат

`createChat()`

createChat($business_id, $create_chat_request): \OpenAPI\Client\Model\CreateChatResponse

Создание нового чата с покупателем

Создает новый чат с покупателем. |⚙️ Лимит: 1000 запросов в час| |-|

Example

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


// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ChatsApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$create_chat_request = new \OpenAPI\Client\Model\CreateChatRequest(); // \OpenAPI\Client\Model\CreateChatRequest | description

try {
    $result = $apiInstance->createChat($business_id, $create_chat_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->createChat: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
create_chat_request	\OpenAPI\Client\Model\CreateChatRequest	description

Return type

\OpenAPI\Client\Model\CreateChatResponse

Authorization

OAuth

HTTP request headers

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

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

`getChatHistory()`

getChatHistory($business_id, $chat_id, $get_chat_history_request, $page_token, $limit): \OpenAPI\Client\Model\GetChatHistoryResponse

Получение истории сообщений в чате

Возвращает историю сообщений в чате с покупателем. |⚙️ Лимит: 10000 запросов в час| |-|

Example

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


// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ChatsApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$chat_id = 56; // int | Идентификатор чата.
$get_chat_history_request = new \OpenAPI\Client\Model\GetChatHistoryRequest(); // \OpenAPI\Client\Model\GetChatHistoryRequest | description
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->getChatHistory($business_id, $chat_id, $get_chat_history_request, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->getChatHistory: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
chat_id	int	Идентификатор чата.
get_chat_history_request	\OpenAPI\Client\Model\GetChatHistoryRequest	description
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]

Return type

\OpenAPI\Client\Model\GetChatHistoryResponse

Authorization

OAuth

HTTP request headers

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

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

`getChats()`

getChats($business_id, $get_chats_request, $page_token, $limit): \OpenAPI\Client\Model\GetChatsResponse

Получение доступных чатов

Возвращает ваши чаты с покупателями. |⚙️ Лимит: 10000 запросов в час| |-|

Example

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


// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ChatsApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$get_chats_request = new \OpenAPI\Client\Model\GetChatsRequest(); // \OpenAPI\Client\Model\GetChatsRequest | description
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->getChats($business_id, $get_chats_request, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->getChats: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
get_chats_request	\OpenAPI\Client\Model\GetChatsRequest	description
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]

Return type

\OpenAPI\Client\Model\GetChatsResponse

Authorization

OAuth

HTTP request headers

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

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

`sendFileToChat()`

sendFileToChat($business_id, $chat_id, $file): \OpenAPI\Client\Model\EmptyApiResponse

Отправка файла в чат

Отправляет файл в чат с покупателем. |⚙️ Лимит: 1000 запросов в час| |-|

Example

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


// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ChatsApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$chat_id = 56; // int | Идентификатор чата.
$file = "/path/to/file.txt"; // \SplFileObject | Содержимое файла. Максимальный размер файла — 5 Мбайт.

try {
    $result = $apiInstance->sendFileToChat($business_id, $chat_id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->sendFileToChat: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
chat_id	int	Идентификатор чата.
file	\SplFileObject\SplFileObject	Содержимое файла. Максимальный размер файла — 5 Мбайт.

Return type

\OpenAPI\Client\Model\EmptyApiResponse

Authorization

OAuth

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`sendMessageToChat()`

sendMessageToChat($business_id, $chat_id, $send_message_to_chat_request): \OpenAPI\Client\Model\EmptyApiResponse

Отправка сообщения в чат

Отправляет сообщение в чат с покупателем. |⚙️ Лимит: 1000 запросов в час| |-|

Example

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


// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ChatsApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$chat_id = 56; // int | Идентификатор чата.
$send_message_to_chat_request = new \OpenAPI\Client\Model\SendMessageToChatRequest(); // \OpenAPI\Client\Model\SendMessageToChatRequest | description

try {
    $result = $apiInstance->sendMessageToChat($business_id, $chat_id, $send_message_to_chat_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChatsApi->sendMessageToChat: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
chat_id	int	Идентификатор чата.
send_message_to_chat_request	\OpenAPI\Client\Model\SendMessageToChatRequest	description

Return type

\OpenAPI\Client\Model\EmptyApiResponse

Authorization

OAuth

HTTP request headers

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ChatsApi.md

ChatsApi.md

OpenAPI\Client\ChatsApi

`createChat()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getChatHistory()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getChats()`

Example

Parameters

Return type

Authorization

HTTP request headers

`sendFileToChat()`

Example

Parameters

Return type

Authorization

HTTP request headers

`sendMessageToChat()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

ChatsApi.md

Latest commit

History

ChatsApi.md

File metadata and controls

OpenAPI\Client\ChatsApi

createChat()

Example

Parameters

Return type

Authorization

HTTP request headers

getChatHistory()

Example

Parameters

Return type

Authorization

HTTP request headers

getChats()

Example

Parameters

Return type

Authorization

HTTP request headers

sendFileToChat()

Example

Parameters

Return type

Authorization

HTTP request headers

sendMessageToChat()

Example

Parameters

Return type

Authorization

HTTP request headers

`createChat()`

`getChatHistory()`

`getChats()`

`sendFileToChat()`

`sendMessageToChat()`