relaya / sdk-php

v0.1.0 2026-08-09 23:33 UTC

Requires

• php: ^8.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.3
• guzzlehttp/psr7: ^1.7 || ^2.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.5
• phpunit/phpunit: ^8.0 || ^9.0

Suggests

• illuminate/support: Laravel integration via auto-discovered service provider.

proprietary

• Релая

• php
• api
• sdk
• messaging
• integrations
• relaya
• max api

Published on Packagist.org on 2026-08-09 23:33 UTC

README

Public customer API for Relaya SDKs. Authenticated with a profile API token (X-Profile-Token). Staff Admin API is intentionally excluded from this contract. Scopes: profiles:read|write, inbox:read|write, webhooks:manage, billing:read|write. Профили, сообщения, инбокс, модули, вебхуки и биллинг.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Install from Packagist:

composer require relaya/sdk-php

For local development in this repository:

composer install

Laravel

The package supports Laravel auto-discovery.

Publish configuration (optional):

php artisan vendor:publish --tag=relaya-sdk-config

Then configure .env, for example:

RELAYA_API_TOKEN=your_token
RELAYA_API_BASE_URL=https://api.relaya.ru/v1

Quick Start (Facade)

<?php

use Relaya\RelayaApi;

RelayaApi::configure(accessToken: 'YOUR_ACCESS_TOKEN');
$result = RelayaApi::AccountApi()->getAccountModules();
print_r($result);

Alias:

<?php

use Relaya\Api;

$result = Api::AccountApi()->getAccountModules();

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/relaya-sdk-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: ApiKeyAuth
$config = Relaya\Sdk\Configuration::getDefaultConfiguration()->setApiKey('X-Profile-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Relaya\Sdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Profile-Token', 'Bearer');


$apiInstance = new Relaya\Sdk\Api\AuthApi(
    // 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
);
$profile_id = 7fa3c1d942be; // string | Идентификатор профиля Релая. Для новых профилей это 12-символьная hex-строка.
$integration = max; // string | Код интеграции профиля: например `max`, `vk`, `telegram`, `telegrambot`, `maxbot`, `whatsapp` или `email`.
$track_id = 'track_id_example'; // string | Параметр `trackId` из `query`.

try {
    $result = $apiInstance->getProfilesProfileIdIntegrationsIntegrationAuthQr($profile_id, $integration, $track_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthApi->getProfilesProfileIdIntegrationsIntegrationAuthQr: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://localhost:8485/v1

Class	Method	HTTP request	Description
AuthApi	getProfilesProfileIdIntegrationsIntegrationAuthQr	GET /profiles/{profileId}/integrations/{integration}/auth/qr	Получить QR-код для авторизации
AuthApi	getProfilesProfileIdIntegrationsIntegrationAuthQrStatus	GET /profiles/{profileId}/integrations/{integration}/auth/qr/status	Получить статус QR-авторизации
AuthApi	getProfilesProfileIdIntegrationsIntegrationGroups	GET /profiles/{profileId}/integrations/{integration}/groups	Получить группы VK
AuthApi	getProfilesProfileIdIntegrationsIntegrationOauthStart	GET /profiles/{profileId}/integrations/{integration}/oauth/start	Начать OAuth для VK
AuthApi	getProfilesProfileIdIntegrationsIntegrationSmtp	GET /profiles/{profileId}/integrations/{integration}/smtp	Получить SMTP-настройки профиля
AuthApi	getProfilesProfileIdIntegrationsIntegrationToken	GET /profiles/{profileId}/integrations/{integration}/token	Получить токен бота
AuthApi	getProfilesProfileIdIntegrationsIntegrationWabaTemplates	GET /profiles/{profileId}/integrations/{integration}/waba/templates	Шаблоны WABA
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuth2fa	POST /profiles/{profileId}/integrations/{integration}/auth/2fa	Отправить пароль 2FA
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthLogout	POST /profiles/{profileId}/integrations/{integration}/auth/logout	Выйти из интеграции
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthPhoneCode	POST /profiles/{profileId}/integrations/{integration}/auth/phone/code	Подтвердить код авторизации по телефону
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthPhoneConfirm	POST /profiles/{profileId}/integrations/{integration}/auth/phone/confirm	Подтвердить вход по телефону
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthPhonePassword	POST /profiles/{profileId}/integrations/{integration}/auth/phone/password	Отправить пароль второго фактора по телефону
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthPhoneStart	POST /profiles/{profileId}/integrations/{integration}/auth/phone/start	Начать авторизацию по телефону
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthSmsPoll	POST /profiles/{profileId}/integrations/{integration}/auth/sms/poll	Проверить статус SMS-авторизации (MAX)
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthSmsStart	POST /profiles/{profileId}/integrations/{integration}/auth/sms/start	Начать SMS-авторизацию (MAX)
AuthApi	postProfilesProfileIdIntegrationsIntegrationAuthSmsVerify	POST /profiles/{profileId}/integrations/{integration}/auth/sms/verify	Отправить код авторизации (MAX)
AuthApi	putProfilesProfileIdIntegrationsIntegrationGroup	PUT /profiles/{profileId}/integrations/{integration}/group	Сохранить группу VK
AuthApi	putProfilesProfileIdIntegrationsIntegrationSmtp	PUT /profiles/{profileId}/integrations/{integration}/smtp	Сохранить SMTP-настройки профиля
AuthApi	putProfilesProfileIdIntegrationsIntegrationToken	PUT /profiles/{profileId}/integrations/{integration}/token	Сохранить токен бота
BillingApi	getBillingCompanyLookup	GET /billing/company-lookup	Подсказки по организации
BillingApi	getBillingInvoice	GET /billing/invoices/{invoiceId}	Карточка счёта
BillingApi	getBillingInvoices	GET /billing/invoices	Список счетов
BillingApi	getBillingInvoicesInvoiceIdAct	GET /billing/invoices/{invoiceId}/act	Скачать акт по счёту
BillingApi	getBillingLegalProfile	GET /billing/legal-profile	Юридический профиль
BillingApi	getBillingTopups	GET /billing/topups	Пополнения
BillingApi	getBillingTopupsTopupId	GET /billing/topups/{topupId}	Статус пополнения
BillingApi	getBillingTransactions	GET /billing/transactions	Транзакции
BillingApi	postBillingInvoiceRefresh	POST /billing/invoices/{invoiceId}/refresh	Обновить статус счёта
BillingApi	postBillingInvoices	POST /billing/invoices	Выставить счёт
BillingApi	postBillingTopups	POST /billing/topups	Создать пополнение
BillingApi	postBillingTopupsTopupIdRefresh	POST /billing/topups/{topupId}/refresh	Обновить статус пополнения
BillingApi	putBillingLegalProfile	PUT /billing/legal-profile	Сохранить юридический профиль
ChatsApi	deleteProfilesProfileIdIntegrationsIntegrationFoldersFolderId	DELETE /profiles/{profileId}/integrations/{integration}/folders/{folderId}	Удалить папку чатов (MAX)
ChatsApi	getProfilesProfileIdIntegrationsIntegrationFolders	GET /profiles/{profileId}/integrations/{integration}/folders	Получить папки чатов (MAX)
ChatsApi	patchProfilesProfileIdIntegrationsIntegrationChatsUpdate	PATCH /profiles/{profileId}/integrations/{integration}/chats/update	Обновить MAX-чат
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsAdmin	POST /profiles/{profileId}/integrations/{integration}/chats/admin	Изменить права администратора в Telegram
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsArchive	POST /profiles/{profileId}/integrations/{integration}/chats/archive	Архивировать или вернуть Telegram-диалог
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsBan	POST /profiles/{profileId}/integrations/{integration}/chats/ban	Изменить ограничения участника в Telegram
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsByIds	POST /profiles/{profileId}/integrations/{integration}/chats/by-ids	Получить чаты по ID (MAX)
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInviteCheck	POST /profiles/{profileId}/integrations/{integration}/chats/invite/check	Проверить Telegram invite-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInviteDelete	POST /profiles/{profileId}/integrations/{integration}/chats/invite/delete	Удалить Telegram invite-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInviteEdit	POST /profiles/{profileId}/integrations/{integration}/chats/invite/edit	Изменить Telegram invite-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInviteExport	POST /profiles/{profileId}/integrations/{integration}/chats/invite/export	Создать Telegram invite-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInviteImport	POST /profiles/{profileId}/integrations/{integration}/chats/invite/import	Принять Telegram invite-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsInvites	POST /profiles/{profileId}/integrations/{integration}/chats/invites	Получить список Telegram invite-ссылок чата
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsJoin	POST /profiles/{profileId}/integrations/{integration}/chats/join	Вступить в чат или канал
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsLeave	POST /profiles/{profileId}/integrations/{integration}/chats/leave	Покинуть чат или канал
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsLinkInfo	POST /profiles/{profileId}/integrations/{integration}/chats/link-info	Разрешить MAX-ссылку
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsList	POST /profiles/{profileId}/integrations/{integration}/chats/list	Получить список чатов (MAX)
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsMembers	POST /profiles/{profileId}/integrations/{integration}/chats/members	Получить участников MAX-чата
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsMembersInvite	POST /profiles/{profileId}/integrations/{integration}/chats/members/invite	Пригласить участников в MAX-канал
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsMute	POST /profiles/{profileId}/integrations/{integration}/chats/mute	Изменить mute-настройки Telegram-диалога
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsPin	POST /profiles/{profileId}/integrations/{integration}/chats/pin	Закрепить или открепить Telegram-диалог
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsResolve	POST /profiles/{profileId}/integrations/{integration}/chats/resolve	Найти чат по телефону или username
ChatsApi	postProfilesProfileIdIntegrationsIntegrationChatsSubscription	POST /profiles/{profileId}/integrations/{integration}/chats/subscription	Изменить подписку на обновления чата (MAX)
ChatsApi	postProfilesProfileIdIntegrationsIntegrationFolders	POST /profiles/{profileId}/integrations/{integration}/folders	Создать папку чатов (MAX)
ChatsApi	putProfilesProfileIdIntegrationsIntegrationFoldersOrder	PUT /profiles/{profileId}/integrations/{integration}/folders/order	Изменить порядок папок (MAX)
InboxApi	getProfilesProfileIdIntegrationsIntegrationInboxConversations	GET /profiles/{profileId}/integrations/{integration}/inbox/conversations	Получить диалоги inbox профиля
InboxApi	getProfilesProfileIdIntegrationsIntegrationInboxMessages	GET /profiles/{profileId}/integrations/{integration}/inbox/messages	Получить сообщения inbox профиля
InboxApi	postProfilesProfileIdIntegrationsIntegrationInboxConversationsAction	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/action	Изменить состояние диалога inbox
InboxApi	postProfilesProfileIdIntegrationsIntegrationInboxConversationsAvatar	POST /profiles/{profileId}/integrations/{integration}/inbox/conversations/avatar	Обновить аватар диалога inbox
InboxApi	postProfilesProfileIdIntegrationsIntegrationInboxRead	POST /profiles/{profileId}/integrations/{integration}/inbox/read	Отметить диалог inbox как прочитанный
MessagesApi	deleteProfilesProfileIdIntegrationsIntegrationMessagesReactions	DELETE /profiles/{profileId}/integrations/{integration}/messages/reactions	Убрать реакцию с сообщения (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationFilesResolve	POST /profiles/{profileId}/integrations/{integration}/files/resolve	Получить ссылки на файл по ID или токену (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessages	POST /profiles/{profileId}/integrations/{integration}/messages	Отправить сообщение
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesDelete	POST /profiles/{profileId}/integrations/{integration}/messages/delete	Удалить сообщение
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesDraft	POST /profiles/{profileId}/integrations/{integration}/messages/draft	Получить черновик Telegram-диалога
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesDraftSave	POST /profiles/{profileId}/integrations/{integration}/messages/draft/save	Сохранить черновик Telegram-диалога
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesEdit	POST /profiles/{profileId}/integrations/{integration}/messages/edit	Изменить сообщение
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesFiles	POST /profiles/{profileId}/integrations/{integration}/messages/files	Загрузить файл для сообщения
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesForward	POST /profiles/{profileId}/integrations/{integration}/messages/forward	Переслать сообщение
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesHistory	POST /profiles/{profileId}/integrations/{integration}/messages/history	Получить историю сообщений чата
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesReactions	POST /profiles/{profileId}/integrations/{integration}/messages/reactions	Поставить реакцию на сообщение (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesRead	POST /profiles/{profileId}/integrations/{integration}/messages/read	Отметить чат как прочитанный (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesReply	POST /profiles/{profileId}/integrations/{integration}/messages/reply	Ответить на сообщение
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesScheduled	POST /profiles/{profileId}/integrations/{integration}/messages/scheduled	Получить отложенные сообщения
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesScheduledDelete	POST /profiles/{profileId}/integrations/{integration}/messages/scheduled/delete	Удалить отложенные сообщения
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesScheduledSend	POST /profiles/{profileId}/integrations/{integration}/messages/scheduled/send	Отправить отложенные сообщения сразу
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesSearch	POST /profiles/{profileId}/integrations/{integration}/messages/search	Найти сообщения в Telegram
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesTranscription	POST /profiles/{profileId}/integrations/{integration}/messages/transcription	Расшифровать медиа MAX
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesTyping	POST /profiles/{profileId}/integrations/{integration}/messages/typing	Отправить статус набора текста (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationMessagesUnread	POST /profiles/{profileId}/integrations/{integration}/messages/unread	Пометить чат как непрочитанный (MAX)
MessagesApi	postProfilesProfileIdIntegrationsIntegrationPollsClose	POST /profiles/{profileId}/integrations/{integration}/polls/close	Закрыть опрос MAX
MessagesApi	postProfilesProfileIdIntegrationsIntegrationPollsUpdates	POST /profiles/{profileId}/integrations/{integration}/polls/updates	Обновить состояние опроса MAX
MessagesApi	postProfilesProfileIdIntegrationsIntegrationPollsVote	POST /profiles/{profileId}/integrations/{integration}/polls/vote	Проголосовать в опросе MAX
MessagesApi	postProfilesProfileIdIntegrationsIntegrationUploadsUrl	POST /profiles/{profileId}/integrations/{integration}/uploads/url	Получить URL загрузки MAX
MessagesApi	postProfilesProfileIdIntegrationsIntegrationVideosResolve	POST /profiles/{profileId}/integrations/{integration}/videos/resolve	Получить ссылки на видео по ID (MAX)
ProfilesApi	deleteProfilesProfileId	DELETE /profiles/{profileId}	Удалить профиль
ProfilesApi	deleteProfilesProfileIdAuthShare	DELETE /profiles/{profileId}/auth-share	Отозвать ссылку
ProfilesApi	deleteProfilesProfileIdScenariosScenarioId	DELETE /profiles/{profileId}/scenarios/{scenarioId}	Удалить сценарий профиля
ProfilesApi	deleteProfilesProfileIdScenariosScenarioIdPresence	DELETE /profiles/{profileId}/scenarios/{scenarioId}/presence	Выйти из редактора
ProfilesApi	deleteProfilesProfileIdScenariosScenarioIdWebhookSecret	DELETE /profiles/{profileId}/scenarios/{scenarioId}/webhook-secret	Отозвать public webhook secret
ProfilesApi	deleteProfilesViewsViewId	DELETE /profiles/views/{viewId}	Удалить вид списка профилей
ProfilesApi	getProfiles	GET /profiles	Получить список профилей
ProfilesApi	getProfilesIds	GET /profiles/ids	Список profileId по фильтрам
ProfilesApi	getProfilesProfileId	GET /profiles/{profileId}	Получить профиль
ProfilesApi	getProfilesProfileIdActions	GET /profiles/{profileId}/actions	Получить журнал действий профиля
ProfilesApi	getProfilesProfileIdIntegrationsIntegrationContacts	GET /profiles/{profileId}/integrations/{integration}/contacts	Получить контакты профиля (MAX)
ProfilesApi	getProfilesProfileIdIntegrationsIntegrationContactsBlocked	GET /profiles/{profileId}/integrations/{integration}/contacts/blocked	Получить заблокированные контакты (MAX)
ProfilesApi	getProfilesProfileIdIntegrationsIntegrationOverview	GET /profiles/{profileId}/integrations/{integration}/overview	Получить обзор профиля
ProfilesApi	getProfilesProfileIdIntegrationsIntegrationStatus	GET /profiles/{profileId}/integrations/{integration}/status	Получить статус профиля
ProfilesApi	getProfilesProfileIdQuotas	GET /profiles/{profileId}/quotas	Квоты профиля
ProfilesApi	getProfilesProfileIdScenarios	GET /profiles/{profileId}/scenarios	Получить сценарии профиля
ProfilesApi	getProfilesProfileIdScenariosScenarioIdAnalytics	GET /profiles/{profileId}/scenarios/{scenarioId}/analytics	Аналитика воронки сценария
ProfilesApi	getProfilesProfileIdScenariosScenarioIdPresence	GET /profiles/{profileId}/scenarios/{scenarioId}/presence	Кто в редакторе
ProfilesApi	getProfilesProfileIdScenariosScenarioIdRuns	GET /profiles/{profileId}/scenarios/{scenarioId}/runs	Список запусков сценария
ProfilesApi	getProfilesProfileIdScenariosScenarioIdRunsTraceId	GET /profiles/{profileId}/scenarios/{scenarioId}/runs/{traceId}	Детали запуска сценария
ProfilesApi	getProfilesViews	GET /profiles/views	Сохранённые виды списка профилей
ProfilesApi	patchProfilesProfileId	PATCH /profiles/{profileId}	Обновить профиль
ProfilesApi	patchProfilesProfileIdIntegrationsIntegrationAccountProfile	PATCH /profiles/{profileId}/integrations/{integration}/account/profile	Обновить имя и описание профиля в MAX
ProfilesApi	postProfiles	POST /profiles	Создать профиль
ProfilesApi	postProfilesBulk	POST /profiles/bulk	Массовые действия над профилями
ProfilesApi	postProfilesProfileIdAuthShare	POST /profiles/{profileId}/auth-share	Ссылка на авторизацию
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationAvatar	POST /profiles/{profileId}/integrations/{integration}/avatar	Обновить аватар профиля (MAX)
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationBotsWebAppInit	POST /profiles/{profileId}/integrations/{integration}/bots/web-app/init	Инициализировать MAX bot web app
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationCallsByPeer	POST /profiles/{profileId}/integrations/{integration}/calls/by-peer	Получить group call Telegram по чату
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationCallsGet	POST /profiles/{profileId}/integrations/{integration}/calls/get	Получить состояние Telegram group call
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationCallsJoin	POST /profiles/{profileId}/integrations/{integration}/calls/join	Присоединиться к Telegram group call
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationCallsLeave	POST /profiles/{profileId}/integrations/{integration}/calls/leave	Покинуть Telegram group call
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationContactsAdd	POST /profiles/{profileId}/integrations/{integration}/contacts/add	Добавить контакт в MAX
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationContactsByIds	POST /profiles/{profileId}/integrations/{integration}/contacts/by-ids	Получить контакты по ID (MAX)
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationContactsCheck	POST /profiles/{profileId}/integrations/{integration}/contacts/check	Проверить, существует ли контакт
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationContactsLastOnline	POST /profiles/{profileId}/integrations/{integration}/contacts/last-online	Получить время последней активности контактов (MAX)
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationContactsSearch	POST /profiles/{profileId}/integrations/{integration}/contacts/search	Найти контакт по телефону или username
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationForumsToggle	POST /profiles/{profileId}/integrations/{integration}/forums/toggle	Изменить режим форума в Telegram
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationReboot	POST /profiles/{profileId}/integrations/{integration}/reboot	Перезапустить профиль (MAX)
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationStories	POST /profiles/{profileId}/integrations/{integration}/stories	Получить активные Telegram stories
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationStoriesPeer	POST /profiles/{profileId}/integrations/{integration}/stories/peer	Получить stories конкретного Telegram peer
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationStoriesReaction	POST /profiles/{profileId}/integrations/{integration}/stories/reaction	Поставить реакцию на Telegram story
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationStoriesRead	POST /profiles/{profileId}/integrations/{integration}/stories/read	Отметить Telegram stories как просмотренные
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationStoriesSend	POST /profiles/{profileId}/integrations/{integration}/stories/send	Опубликовать Telegram story
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationTopics	POST /profiles/{profileId}/integrations/{integration}/topics	Получить список Telegram forum topics
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationTopicsCreate	POST /profiles/{profileId}/integrations/{integration}/topics/create	Создать Telegram forum topic
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationTopicsDelete	POST /profiles/{profileId}/integrations/{integration}/topics/delete	Удалить историю Telegram forum topic
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationTopicsEdit	POST /profiles/{profileId}/integrations/{integration}/topics/edit	Изменить Telegram forum topic
ProfilesApi	postProfilesProfileIdIntegrationsIntegrationTopicsReorder	POST /profiles/{profileId}/integrations/{integration}/topics/reorder	Переупорядочить закрепленные Telegram forum topics
ProfilesApi	postProfilesProfileIdRenew	POST /profiles/{profileId}/renew	Продлить профиль
ProfilesApi	postProfilesProfileIdScenariosAiDraft	POST /profiles/{profileId}/scenarios/ai-draft	AI-черновик сценария
ProfilesApi	postProfilesProfileIdScenariosScenarioIdPublish	POST /profiles/{profileId}/scenarios/{scenarioId}/publish	Опубликовать черновик сценария
ProfilesApi	postProfilesProfileIdScenariosScenarioIdRollback	POST /profiles/{profileId}/scenarios/{scenarioId}/rollback	Откатить черновик к published
ProfilesApi	postProfilesProfileIdScenariosScenarioIdRunsTraceIdEvents	POST /profiles/{profileId}/scenarios/{scenarioId}/runs/{traceId}/events	Возобновить ожидающий сценарий
ProfilesApi	postProfilesProfileIdScenariosScenarioIdWebhook	POST /profiles/{profileId}/scenarios/{scenarioId}/webhook	Запустить сценарий вебхуком
ProfilesApi	postProfilesProfileIdScenariosScenarioIdWebhookSecret	POST /profiles/{profileId}/scenarios/{scenarioId}/webhook-secret	Выпустить public webhook secret
ProfilesApi	postProfilesProfileIdScenariosSimulate	POST /profiles/{profileId}/scenarios/simulate	Симулировать сценарий
ProfilesApi	postProfilesViews	POST /profiles/views	Создать вид списка профилей
ProfilesApi	putProfilesProfileIdAutoRenew	PUT /profiles/{profileId}/auto-renew	Обновить автопродление профиля
ProfilesApi	putProfilesProfileIdScenarios	PUT /profiles/{profileId}/scenarios	Создать или обновить сценарий профиля
ProfilesApi	putProfilesProfileIdScenariosScenarioIdPresence	PUT /profiles/{profileId}/scenarios/{scenarioId}/presence	Присутствие в редакторе
SessionsApi	deleteProfilesProfileIdIntegrationsIntegrationSession	DELETE /profiles/{profileId}/integrations/{integration}/session	Очистить текущую сессию
SessionsApi	getProfilesProfileIdIntegrationsIntegrationDevices	GET /profiles/{profileId}/integrations/{integration}/devices	Получить активные устройства (MAX)
SessionsApi	getProfilesProfileIdIntegrationsIntegrationSession	GET /profiles/{profileId}/integrations/{integration}/session	Получить данные текущей сессии
SessionsApi	getProfilesProfileIdIntegrationsIntegrationSessionChats	GET /profiles/{profileId}/integrations/{integration}/session/chats	Получить чаты текущей сессии
SessionsApi	getProfilesProfileIdIntegrationsIntegrationSessions	GET /profiles/{profileId}/integrations/{integration}/sessions	Получить активные сессии (MAX)
SessionsApi	postProfilesProfileIdIntegrationsIntegrationSessionEvents	POST /profiles/{profileId}/integrations/{integration}/session/events	Получить события текущей сессии
SessionsApi	postProfilesProfileIdIntegrationsIntegrationSessionStart	POST /profiles/{profileId}/integrations/{integration}/session/start	Запустить интеграционную сессию
SessionsApi	postProfilesProfileIdIntegrationsIntegrationSessionStop	POST /profiles/{profileId}/integrations/{integration}/session/stop	Остановить интеграционную сессию
SessionsApi	postProfilesProfileIdIntegrationsIntegrationSessionsClose	POST /profiles/{profileId}/integrations/{integration}/sessions/close	Завершить остальные MAX-сессии
SessionsApi	postProfilesProfileIdIntegrationsIntegrationSync	POST /profiles/{profileId}/integrations/{integration}/sync	Синхронизировать профиль с интеграцией
SessionsApi	putProfilesProfileIdIntegrationsIntegrationSession	PUT /profiles/{profileId}/integrations/{integration}/session	Сохранить данные текущей сессии
SettingsApi	getProfilesProfileIdIntegrationsIntegrationSettingsUser	GET /profiles/{profileId}/integrations/{integration}/settings/user	Получить настройки аккаунта (MAX)
SettingsApi	patchProfilesProfileIdIntegrationsIntegrationSettingsUser	PATCH /profiles/{profileId}/integrations/{integration}/settings/user	Обновить настройки аккаунта (MAX)
WebhooksApi	deleteProfilesProfileIdIntegrationsIntegrationWebhook	DELETE /profiles/{profileId}/integrations/{integration}/webhook	Отключить входящий webhook интеграции
WebhooksApi	deleteProfilesProfileIdIntegrationsIntegrationWebhooksId	DELETE /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Удалить вебхук
WebhooksApi	getProfilesProfileIdIntegrationsIntegrationWebhook	GET /profiles/{profileId}/integrations/{integration}/webhook	Получить входящий webhook интеграции
WebhooksApi	getProfilesProfileIdIntegrationsIntegrationWebhooks	GET /profiles/{profileId}/integrations/{integration}/webhooks	Получить список вебхуков
WebhooksApi	getProfilesProfileIdIntegrationsIntegrationWebhooksDlq	GET /profiles/{profileId}/integrations/{integration}/webhooks/dlq	Получить сообщения DLQ вебхуков
WebhooksApi	getProfilesProfileIdIntegrationsIntegrationWebhooksEvents	GET /profiles/{profileId}/integrations/{integration}/webhooks/events	Получить каталог событий вебхуков
WebhooksApi	getProfilesProfileIdIntegrationsIntegrationWebhooksId	GET /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Получить вебхук
WebhooksApi	patchProfilesProfileIdIntegrationsIntegrationWebhooksId	PATCH /profiles/{profileId}/integrations/{integration}/webhooks/{id}	Обновить вебхук
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhookSubscribe	POST /profiles/{profileId}/integrations/{integration}/webhook/subscribe	Подписать входящий webhook интеграции
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhookUnsubscribe	POST /profiles/{profileId}/integrations/{integration}/webhook/unsubscribe	Отключить входящий webhook интеграции
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhooks	POST /profiles/{profileId}/integrations/{integration}/webhooks	Создать вебхук
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhooksCheck	POST /profiles/{profileId}/integrations/{integration}/webhooks/check	Проверить адрес вебхука
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhooksDlqRedrive	POST /profiles/{profileId}/integrations/{integration}/webhooks/dlq/redrive	Повторно отправить сообщения из DLQ
WebhooksApi	postProfilesProfileIdIntegrationsIntegrationWebhooksIdTest	POST /profiles/{profileId}/integrations/{integration}/webhooks/{id}/test	Отправить тестовый вебхук

Models

• AppliedPromotionSummary
• AuthorizationResultData
• BillingInvoiceItem
• BotTokenInputBody
• BotTokenResponseBody
• BotTokenSetResponseBody
• ChatHistoryInputBody
• Company
• CompanyLookupOutputBody
• ContactCheckInputBody
• ContactCheckResponseBody
• ContactsListHumaBody
• ConversationActionInputBody
• ConversationActionResponseBody
• ConversationAvatarInputBody
• ConversationAvatarMeta
• ConversationAvatarResponseBody
• ConversationMeta
• CreateAuthShareBody
• CreateAuthShareResponse
• CreateBillingInvoiceInputBody
• CreateProfileInputBody
• DeleteMessageBody
• DeleteMessageInputBody
• DeleteProfilesProfileIdAuthShareResponse
• EditMessageInputBody
• EmailSMTPConfigResponseBody
• EmailSMTPSetInputBody
• EmailSMTPSetResponseBody
• ErrorDetail
• ErrorModel
• ForwardMessageInputBody
• InboxConversationItem
• InboxConversationsListResponseBody
• InboxMessageItem
• InboxMessagesListResponseBody
• InboxReadInputBody
• InboxReadResponseBody
• Item
• LegalProfileBody
• ListBillingInvoicesOutputBody
• LogoutBody
• MaxBlockedContactsResponseBody
• MaxChannelInviteInputBody
• MaxChannelInviteResponseBody
• MaxChatMembersInputBody
• MaxChatMembersResponseBody
• MaxChatSubscriptionInputBody
• MaxChatSubscriptionResponseBody
• MaxChatUpdateInputBody
• MaxChatUpdateResponseBody
• MaxChatsByIDsInputBody
• MaxChatsByIDsResponseBody
• MaxChatsListInputBody
• MaxChatsListResponseBody
• MaxCloseSessionsResponseBody
• MaxContact
• MaxContactAddInputBody
• MaxContactAddResponseBody
• MaxContactName
• MaxContactsByIDsInputBody
• MaxContactsByIDsResponseBody
• MaxContactsLastOnlineInputBody
• MaxContactsLastOnlineResponseBody
• MaxCreateFolderInputBody
• MaxFileResolveInputBody
• MaxFileResolveResponseBody
• MaxFolder
• MaxFoldersResponseBody
• MaxGenericActionResponseBody
• MaxLinkInfoInputBody
• MaxLinkInfoResponseBody
• MaxMessageTranscriptionInputBody
• MaxMessageTranscriptionResponseBody
• MaxPollCloseInputBody
• MaxPollUpdateInputBody
• MaxPollVoteInputBody
• MaxProfile
• MaxReorderFoldersInputBody
• MaxResolveChatByPhoneInputBody
• MaxResolveChatByPhoneResponseBody
• MaxSession
• MaxSessionsResponseBody
• MaxSetProfileInputBody
• MaxSetProfileResponseBody
• MaxSetUserSettingsInputBody
• MaxUploadURLInputBody
• MaxUploadURLResponseBody
• MaxUserSettingsPatch
• MaxUserSettingsResponseBody
• MaxUserSettingsState
• MaxVideoResolveInputBody
• MaxVideoResolveResponseBody
• MaxWebAppInitInputBody
• MaxWebAppInitResponseBody
• MessageResponseBody
• Password2FAInputBody
• PhoneAuthCodeInputBody
• PhoneAuthCodeResponseBody
• PhoneAuthConfirmInputBody
• PhoneAuthConfirmResponseBody
• PhoneAuthPasswordInputBody
• PhoneAuthPasswordResponseBody
• PhoneAuthStartInputBody
• PhoneAuthStartResponseBody
• Poll
• PollAuthorizationBody
• PollAuthorizationInputBody
• ProfileActionItem
• ProfileActionsListResponseBody
• ProfileListViewBody
• ProfileListViewCreateInputBody
• ProfileListViewDeleteResponseBody
• ProfileListViewsResponseBody
• ProfileOverviewBody
• ProfileReadinessBody
• ProfileReadinessChecksBody
• ProfileRenewOutputBody
• ProfileResponse
• ProfilesBulkInputBody
• ProfilesBulkItemError
• ProfilesBulkItemResult
• ProfilesBulkMatchFilter
• ProfilesBulkOutputBody
• ProfilesIDsResponseBody
• ProfilesListResponseBody
• ProfilesListSummaryBody
• ProfilesListSummaryBodyExpiringWithinDaysStruct
• ProfilesListSummaryBodyOwnershipStruct
• ProfilesListSummaryBodyReadinessStruct
• ProfilesListSummaryBodySubscriptionStruct
• QRStatusResponseBody
• QuotaResponse
• QuotasListResponseBody
• ReactionRef
• ReactionStruct
• ReadChatBody
• ReadChatHumaInputBody
• RebootProfileBody
• RefreshBillingInvoiceOutputBody
• RemoveReactionBody
• RemoveReactionHumaInputBody
• RenewProfileInputBody
• SearchContactInputBody
• SearchContactResponseBody
• SendAuthorizationCodeBody
• SendAuthorizationCodeInputBody
• SendMessageInputBody
• SendReactionBody
• SendReactionHumaInputBody
• SendReplyMessageInputBody
• SendTypingInputBody
• SendTypingResponseBody
• SessionActionInputBody
• SessionChatsResponseBody
• SessionClearResponseBody
• SessionDataInputBody
• SessionEventsResponseBody
• SessionGetResponseBody
• SessionSetResponseBody
• SessionStartInputBody
• SessionStartResponseBody
• SessionStopResponseBody
• StartAuthorizationBody
• StartAuthorizationInputBody
• StateProfileBody
• SyncProfileInputBody
• SyncProfileResponseBody
• TopUpInputBody
• TopUpResponseBody
• TopUpStatusResponseBody
• TopUpStatusResponseItem
• TopUpsListResponseBody
• TransactionItem
• TransactionsListResponseBody
• UpdateProfileAutoRenewInputBody
• UpdateProfileInputBody
• WABAMessageTemplateItem
• WABAMessageTemplatesResponseBody

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Profile-Token
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: devel
  • Generator version: 7.20.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen